Properties /access_ codes/create /access_ codes/create : { commonParams : {} ; formData : {} ; jsonBody : { allow_external_modification ?: boolean ; attempt_for_offline_device ?: boolean ; code ?: string ; common_code_key ?: string ; device_id : string ; ends_at ?: string ; is_external_modification_allowed ?: boolean ; is_offline_access_code ?: boolean ; is_one_time_use ?: boolean ; max_time_rounding ?: "1hour" | "1day" | "1h" | "1d" ; name ?: string ; prefer_native_scheduling ?: boolean ; starts_at ?: string ; sync ?: boolean ; use_backup_access_code_pool ?: boolean ; use_offline_access_code ?: boolean ; } ; jsonResponse : { access_code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/access_codes/create" ; }
Type declaration common Params : {} form Data : {} json Body : { allow_external_modification ?: boolean ; attempt_for_offline_device ?: boolean ; code ?: string ; common_code_key ?: string ; device_id : string ; ends_at ?: string ; is_external_modification_allowed ?: boolean ; is_offline_access_code ?: boolean ; is_one_time_use ?: boolean ; max_time_rounding ?: "1hour" | "1day" | "1h" | "1d" ; name ?: string ; prefer_native_scheduling ?: boolean ; starts_at ?: string ; sync ?: boolean ; use_backup_access_code_pool ?: boolean ; use_offline_access_code ?: boolean ; } Optional
allow_ external_ modification ?: boolean Optional
attempt_ for_ offline_ device ?: boolean Optional
code ?: string Optional
common_ code_ key ?: string device_ id : string Optional
ends_ at ?: string Optional
is_ external_ modification_ allowed ?: boolean Optional
is_ offline_ access_ code ?: boolean Optional
is_ one_ time_ use ?: boolean Optional
max_ time_ rounding ?: "1hour" | "1day" | "1h" | "1d" Optional
name ?: string Optional
prefer_ native_ scheduling ?: boolean Optional
starts_ at ?: string Optional
sync ?: boolean Optional
use_ backup_ access_ code_ pool ?: boolean Optional
use_ offline_ access_ code ?: boolean json Response : { access_code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } access_ code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } access_ code_ id : string code : null | string common_ code_ key : null | string created_ at : string device_ id : string Optional
ends_ at ?: null | string Optional
errors ?: any Optional
is_ backup ?: boolean is_ backup_ access_ code_ available : boolean is_ external_ modification_ allowed : boolean is_ managed : true is_ offline_ access_ code : boolean is_ one_ time_ use : boolean Optional
is_ scheduled_ on_ device ?: boolean Optional
is_ waiting_ for_ code_ assignment ?: boolean name : null | string Optional
pulled_ backup_ access_ code_ id ?: null | string Optional
starts_ at ?: null | string status : "set" | "unknown" | "setting" | "unset" | "removing" type : "time_bound" | "ongoing" Optional
warnings ?: any action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/access_codes/create" Defined in src/lib/seam/connect/route-types.ts:2 /access_ codes/create_ multiple /access_ codes/create_ multiple : { commonParams : {} ; formData : {} ; jsonBody : { allow_external_modification ?: boolean ; attempt_for_offline_device ?: boolean ; behavior_when_code_cannot_be_shared ?: "throw" | "create_random_code" ; code ?: string ; device_ids : string [] ; ends_at ?: string ; is_external_modification_allowed ?: boolean ; is_offline_access_code ?: boolean ; is_one_time_use ?: boolean ; max_time_rounding ?: "1hour" | "1day" | "1h" | "1d" ; name ?: string ; prefer_native_scheduling ?: boolean ; preferred_code_length ?: number ; starts_at ?: string ; use_backup_access_code_pool ?: boolean ; use_offline_access_code ?: boolean ; } ; jsonResponse : { access_codes : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] ; } ; method : "POST" | "PUT" ; queryParams : {} ; route : "/access_codes/create_multiple" ; }
Type declaration common Params : {} form Data : {} json Body : { allow_external_modification ?: boolean ; attempt_for_offline_device ?: boolean ; behavior_when_code_cannot_be_shared ?: "throw" | "create_random_code" ; code ?: string ; device_ids : string [] ; ends_at ?: string ; is_external_modification_allowed ?: boolean ; is_offline_access_code ?: boolean ; is_one_time_use ?: boolean ; max_time_rounding ?: "1hour" | "1day" | "1h" | "1d" ; name ?: string ; prefer_native_scheduling ?: boolean ; preferred_code_length ?: number ; starts_at ?: string ; use_backup_access_code_pool ?: boolean ; use_offline_access_code ?: boolean ; } Optional
allow_ external_ modification ?: boolean Optional
attempt_ for_ offline_ device ?: boolean Optional
behavior_ when_ code_ cannot_ be_ shared ?: "throw" | "create_random_code" Optional
code ?: string device_ ids : string [] Optional
ends_ at ?: string Optional
is_ external_ modification_ allowed ?: boolean Optional
is_ offline_ access_ code ?: boolean Optional
is_ one_ time_ use ?: boolean Optional
max_ time_ rounding ?: "1hour" | "1day" | "1h" | "1d" Optional
name ?: string Optional
prefer_ native_ scheduling ?: boolean Optional
preferred_ code_ length ?: number Optional
starts_ at ?: string Optional
use_ backup_ access_ code_ pool ?: boolean Optional
use_ offline_ access_ code ?: boolean json Response : { access_codes : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] ; } access_ codes : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] method : "POST" | "PUT" query Params : {} route : "/access_codes/create_multiple" Defined in src/lib/seam/connect/route-types.ts:100 /access_ codes/delete /access_ codes/delete : { commonParams : { access_code_id : string ; device_id ?: string ; sync ?: boolean ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/access_codes/delete" ; }
Type declaration common Params : { access_code_id : string ; device_id ?: string ; sync ?: boolean ; } access_ code_ id : string Optional
device_ id ?: string Optional
sync ?: boolean form Data : {} json Body : {} json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" | "DELETE" query Params : {} route : "/access_codes/delete" Defined in src/lib/seam/connect/route-types.ts:173 /access_ codes/generate_ code /access_ codes/generate_ code : { commonParams : { device_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { generated_code : { code : string ; device_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/access_codes/generate_code" ; }
Type declaration common Params : { device_id : string ; } form Data : {} json Body : {} json Response : { generated_code : { code : string ; device_id : string ; } ; } generated_ code : { code : string ; device_id : string ; } code : string device_ id : string method : "GET" | "POST" query Params : {} route : "/access_codes/generate_code" Defined in src/lib/seam/connect/route-types.ts:212 /access_ codes/get /access_ codes/get : { commonParams : { access_code_id ?: string ; code ?: string ; device_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { access_code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/access_codes/get" ; }
Type declaration common Params : { access_code_id ?: string ; code ?: string ; device_id ?: string ; } Optional
access_ code_ id ?: string Optional
code ?: string Optional
device_ id ?: string form Data : {} json Body : {} json Response : { access_code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } access_ code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } access_ code_ id : string code : null | string common_ code_ key : null | string created_ at : string device_ id : string Optional
ends_ at ?: null | string Optional
errors ?: any Optional
is_ backup ?: boolean is_ backup_ access_ code_ available : boolean is_ external_ modification_ allowed : boolean is_ managed : true is_ offline_ access_ code : boolean is_ one_ time_ use : boolean Optional
is_ scheduled_ on_ device ?: boolean Optional
is_ waiting_ for_ code_ assignment ?: boolean name : null | string Optional
pulled_ backup_ access_ code_ id ?: null | string Optional
starts_ at ?: null | string status : "set" | "unknown" | "setting" | "unset" | "removing" type : "time_bound" | "ongoing" Optional
warnings ?: any method : "GET" | "POST" query Params : {} route : "/access_codes/get" Defined in src/lib/seam/connect/route-types.ts:228 /access_ codes/list /access_ codes/list : { commonParams : { access_code_ids ?: string [] ; device_id ?: string ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { access_codes : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/access_codes/list" ; }
Type declaration common Params : { access_code_ids ?: string [] ; device_id ?: string ; user_identifier_key ?: string ; } Optional
access_ code_ ids ?: string [] Optional
device_ id ?: string Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { access_codes : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] ; } access_ codes : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] method : "GET" | "POST" query Params : {} route : "/access_codes/list" Defined in src/lib/seam/connect/route-types.ts:288 /access_ codes/pull_ backup_ access_ code /access_ codes/pull_ backup_ access_ code : { commonParams : {} ; formData : {} ; jsonBody : { access_code_id : string ; } ; jsonResponse : { backup_access_code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } ; method : "POST" ; queryParams : {} ; route : "/access_codes/pull_backup_access_code" ; }
Type declaration common Params : {} form Data : {} json Body : { access_code_id : string ; } json Response : { backup_access_code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } backup_ access_ code : { access_code_id : string ; code : null | string ; common_code_key : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_backup ?: boolean ; is_backup_access_code_available : boolean ; is_external_modification_allowed : boolean ; is_managed : true ; is_offline_access_code : boolean ; is_one_time_use : boolean ; is_scheduled_on_device ?: boolean ; is_waiting_for_code_assignment ?: boolean ; name : null | string ; pulled_backup_access_code_id ?: null | string ; starts_at ?: null | string ; status : "set" | "unknown" | "setting" | "unset" | "removing" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } access_ code_ id : string code : null | string common_ code_ key : null | string created_ at : string device_ id : string Optional
ends_ at ?: null | string Optional
errors ?: any Optional
is_ backup ?: boolean is_ backup_ access_ code_ available : boolean is_ external_ modification_ allowed : boolean is_ managed : true is_ offline_ access_ code : boolean is_ one_ time_ use : boolean Optional
is_ scheduled_ on_ device ?: boolean Optional
is_ waiting_ for_ code_ assignment ?: boolean name : null | string Optional
pulled_ backup_ access_ code_ id ?: null | string Optional
starts_ at ?: null | string status : "set" | "unknown" | "setting" | "unset" | "removing" type : "time_bound" | "ongoing" Optional
warnings ?: any method : "POST" query Params : {} route : "/access_codes/pull_backup_access_code" Defined in src/lib/seam/connect/route-types.ts:348 /access_ codes/simulate/create_ unmanaged_ access_ code /access_ codes/simulate/create_ unmanaged_ access_ code : { commonParams : {} ; formData : {} ; jsonBody : { code : string ; device_id : string ; name : string ; } ; jsonResponse : { access_code : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } ; method : "POST" ; queryParams : {} ; route : "/access_codes/simulate/create_unmanaged_access_code" ; }
Type declaration common Params : {} form Data : {} json Body : { code : string ; device_id : string ; name : string ; } code : string device_ id : string name : string json Response : { access_code : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } access_ code : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } access_ code_ id : string code : null | string created_ at : string device_ id : string Optional
ends_ at ?: null | string Optional
errors ?: any is_ managed : false name : null | string Optional
starts_ at ?: null | string status : "set" type : "time_bound" | "ongoing" Optional
warnings ?: any method : "POST" query Params : {} route : "/access_codes/simulate/create_unmanaged_access_code" Defined in src/lib/seam/connect/route-types.ts:406 /access_ codes/unmanaged/convert_ to_ managed /access_ codes/unmanaged/convert_ to_ managed : { commonParams : { access_code_id : string ; allow_external_modification ?: boolean ; force ?: boolean ; is_external_modification_allowed ?: boolean ; sync ?: boolean ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/access_codes/unmanaged/convert_to_managed" ; }
Type declaration common Params : { access_code_id : string ; allow_external_modification ?: boolean ; force ?: boolean ; is_external_modification_allowed ?: boolean ; sync ?: boolean ; } access_ code_ id : string Optional
allow_ external_ modification ?: boolean Optional
force ?: boolean Optional
is_ external_ modification_ allowed ?: boolean Optional
sync ?: boolean form Data : {} json Body : {} json Response : {} method : "POST" | "PATCH" query Params : {} route : "/access_codes/unmanaged/convert_to_managed" Defined in src/lib/seam/connect/route-types.ts:444 /access_ codes/unmanaged/delete /access_ codes/unmanaged/delete : { commonParams : { access_code_id : string ; sync ?: boolean ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/access_codes/unmanaged/delete" ; }
Type declaration common Params : { access_code_id : string ; sync ?: boolean ; } access_ code_ id : string Optional
sync ?: boolean form Data : {} json Body : {} json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" | "DELETE" query Params : {} route : "/access_codes/unmanaged/delete" Defined in src/lib/seam/connect/route-types.ts:459 /access_ codes/unmanaged/get /access_ codes/unmanaged/get : { commonParams : { access_code_id ?: string ; code ?: string ; device_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { access_code : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/access_codes/unmanaged/get" ; }
Type declaration common Params : { access_code_id ?: string ; code ?: string ; device_id ?: string ; } Optional
access_ code_ id ?: string Optional
code ?: string Optional
device_ id ?: string form Data : {} json Body : {} json Response : { access_code : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } ; } access_ code : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } access_ code_ id : string code : null | string created_ at : string device_ id : string Optional
ends_ at ?: null | string Optional
errors ?: any is_ managed : false name : null | string Optional
starts_ at ?: null | string status : "set" type : "time_bound" | "ongoing" Optional
warnings ?: any method : "GET" | "POST" query Params : {} route : "/access_codes/unmanaged/get" Defined in src/lib/seam/connect/route-types.ts:497 /access_ codes/unmanaged/list /access_ codes/unmanaged/list : { commonParams : { device_id : string ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { access_codes : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/access_codes/unmanaged/list" ; }
Type declaration common Params : { device_id : string ; user_identifier_key ?: string ; } device_ id : string Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { access_codes : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] ; } access_ codes : { access_code_id : string ; code : null | string ; created_at : string ; device_id : string ; ends_at ?: null | string ; errors ?: any ; is_managed : false ; name : null | string ; starts_at ?: null | string ; status : "set" ; type : "time_bound" | "ongoing" ; warnings ?: any ; } [] method : "GET" | "POST" query Params : {} route : "/access_codes/unmanaged/list" Defined in src/lib/seam/connect/route-types.ts:535 /access_ codes/unmanaged/update /access_ codes/unmanaged/update : { commonParams : { access_code_id : string ; allow_external_modification ?: boolean ; force ?: boolean ; is_external_modification_allowed ?: boolean ; is_managed : boolean ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/access_codes/unmanaged/update" ; }
Type declaration common Params : { access_code_id : string ; allow_external_modification ?: boolean ; force ?: boolean ; is_external_modification_allowed ?: boolean ; is_managed : boolean ; } access_ code_ id : string Optional
allow_ external_ modification ?: boolean Optional
force ?: boolean Optional
is_ external_ modification_ allowed ?: boolean is_ managed : boolean form Data : {} json Body : {} json Response : {} method : "POST" | "PATCH" query Params : {} route : "/access_codes/unmanaged/update" Defined in src/lib/seam/connect/route-types.ts:572 /access_ codes/update /access_ codes/update : { commonParams : {} ; formData : {} ; jsonBody : { access_code_id : string ; allow_external_modification ?: boolean ; attempt_for_offline_device ?: boolean ; code ?: string ; device_id ?: string ; ends_at ?: string ; is_external_modification_allowed ?: boolean ; is_managed ?: boolean ; is_offline_access_code ?: boolean ; is_one_time_use ?: boolean ; max_time_rounding ?: "1hour" | "1day" | "1h" | "1d" ; name ?: string ; prefer_native_scheduling ?: boolean ; starts_at ?: string ; sync ?: boolean ; type ?: "time_bound" | "ongoing" ; use_backup_access_code_pool ?: boolean ; use_offline_access_code ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" | "PUT" | "PATCH" ; queryParams : {} ; route : "/access_codes/update" ; }
Type declaration common Params : {} form Data : {} json Body : { access_code_id : string ; allow_external_modification ?: boolean ; attempt_for_offline_device ?: boolean ; code ?: string ; device_id ?: string ; ends_at ?: string ; is_external_modification_allowed ?: boolean ; is_managed ?: boolean ; is_offline_access_code ?: boolean ; is_one_time_use ?: boolean ; max_time_rounding ?: "1hour" | "1day" | "1h" | "1d" ; name ?: string ; prefer_native_scheduling ?: boolean ; starts_at ?: string ; sync ?: boolean ; type ?: "time_bound" | "ongoing" ; use_backup_access_code_pool ?: boolean ; use_offline_access_code ?: boolean ; } access_ code_ id : string Optional
allow_ external_ modification ?: boolean Optional
attempt_ for_ offline_ device ?: boolean Optional
code ?: string Optional
device_ id ?: string Optional
ends_ at ?: string Optional
is_ external_ modification_ allowed ?: boolean Optional
is_ managed ?: boolean Optional
is_ offline_ access_ code ?: boolean Optional
is_ one_ time_ use ?: boolean Optional
max_ time_ rounding ?: "1hour" | "1day" | "1h" | "1d" Optional
name ?: string Optional
prefer_ native_ scheduling ?: boolean Optional
starts_ at ?: string Optional
sync ?: boolean Optional
type ?: "time_bound" | "ongoing" Optional
use_ backup_ access_ code_ pool ?: boolean Optional
use_ offline_ access_ code ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" | "PUT" | "PATCH" query Params : {} route : "/access_codes/update" Defined in src/lib/seam/connect/route-types.ts:587 /acs/access_ groups/add_ user /acs/access_ groups/add_ user : { commonParams : { acs_access_group_id : string ; acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PUT" ; queryParams : {} ; route : "/acs/access_groups/add_user" ; }
Type declaration common Params : { acs_access_group_id : string ; acs_user_id : string ; } acs_ access_ group_ id : string acs_ user_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "PUT" query Params : {} route : "/acs/access_groups/add_user" Defined in src/lib/seam/connect/route-types.ts:641 /acs/access_ groups/get /acs/access_ groups/get : { commonParams : { acs_access_group_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_access_group : { access_group_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; access_group_type_display_name : string ; acs_access_group_id : string ; acs_system_id : string ; created_at : string ; external_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; external_type_display_name : string ; name : string ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/access_groups/get" ; }
Type declaration common Params : { acs_access_group_id : string ; } acs_ access_ group_ id : string form Data : {} json Body : {} json Response : { acs_access_group : { access_group_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; access_group_type_display_name : string ; acs_access_group_id : string ; acs_system_id : string ; created_at : string ; external_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; external_type_display_name : string ; name : string ; workspace_id : string ; } ; } acs_ access_ group : { access_group_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; access_group_type_display_name : string ; acs_access_group_id : string ; acs_system_id : string ; created_at : string ; external_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; external_type_display_name : string ; name : string ; workspace_id : string ; } access_ group_ type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" access_ group_ type_ display_ name : string acs_ access_ group_ id : string acs_ system_ id : string created_ at : string external_ type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" external_ type_ display_ name : string name : string workspace_ id : string method : "GET" | "POST" query Params : {} route : "/acs/access_groups/get" Defined in src/lib/seam/connect/route-types.ts:653 /acs/access_ groups/list /acs/access_ groups/list : { commonParams : { acs_system_id ?: string ; acs_user_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_access_groups : { access_group_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; access_group_type_display_name : string ; acs_access_group_id : string ; acs_system_id : string ; created_at : string ; external_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; external_type_display_name : string ; name : string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/access_groups/list" ; }
Type declaration common Params : { acs_system_id ?: string ; acs_user_id ?: string ; } Optional
acs_ system_ id ?: string Optional
acs_ user_ id ?: string form Data : {} json Body : {} json Response : { acs_access_groups : { access_group_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; access_group_type_display_name : string ; acs_access_group_id : string ; acs_system_id : string ; created_at : string ; external_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; external_type_display_name : string ; name : string ; workspace_id : string ; } [] ; } acs_ access_ groups : { access_group_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; access_group_type_display_name : string ; acs_access_group_id : string ; acs_system_id : string ; created_at : string ; external_type : "pti_unit" | "pti_access_level" | "salto_access_group" | "brivo_group" ; external_type_display_name : string ; name : string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/acs/access_groups/list" Defined in src/lib/seam/connect/route-types.ts:694 /acs/access_ groups/list_ users /acs/access_ groups/list_ users : { commonParams : { acs_access_group_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/access_groups/list_users" ; }
Type declaration common Params : { acs_access_group_id : string ; } acs_ access_ group_ id : string form Data : {} json Body : {} json Response : { acs_users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] ; } acs_ users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/acs/access_groups/list_users" Defined in src/lib/seam/connect/route-types.ts:736 /acs/access_ groups/remove_ user /acs/access_ groups/remove_ user : { commonParams : { acs_access_group_id : string ; acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/acs/access_groups/remove_user" ; }
Type declaration common Params : { acs_access_group_id : string ; acs_user_id : string ; } acs_ access_ group_ id : string acs_ user_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/acs/access_groups/remove_user" Defined in src/lib/seam/connect/route-types.ts:786 /acs/credential_ pools/list /acs/credential_ pools/list : { commonParams : { acs_system_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credential_pools : { acs_credential_pool_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; external_type : "hid_part_number" ; external_type_display_name : string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/credential_pools/list" ; }
Type declaration common Params : { acs_system_id : string ; } form Data : {} json Body : {} json Response : { acs_credential_pools : { acs_credential_pool_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; external_type : "hid_part_number" ; external_type_display_name : string ; workspace_id : string ; } [] ; } acs_ credential_ pools : { acs_credential_pool_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; external_type : "hid_part_number" ; external_type_display_name : string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/acs/credential_pools/list" Defined in src/lib/seam/connect/route-types.ts:798 /acs/credential_ provisioning_ automations/launch /acs/credential_ provisioning_ automations/launch : { commonParams : { acs_credential_pool_id ?: string ; create_credential_manager_user ?: boolean ; credential_manager_acs_system_id : string ; credential_manager_acs_user_id ?: string ; user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credential_provisioning_automation : { acs_credential_provisioning_automation_id : string ; created_at : string ; credential_manager_acs_system_id : string ; user_identity_id : string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/acs/credential_provisioning_automations/launch" ; }
Type declaration common Params : { acs_credential_pool_id ?: string ; create_credential_manager_user ?: boolean ; credential_manager_acs_system_id : string ; credential_manager_acs_user_id ?: string ; user_identity_id : string ; } Optional
acs_ credential_ pool_ id ?: string Optional
create_ credential_ manager_ user ?: boolean credential_ manager_ acs_ system_ id : string Optional
credential_ manager_ acs_ user_ id ?: string user_ identity_ id : string form Data : {} json Body : {} json Response : { acs_credential_provisioning_automation : { acs_credential_provisioning_automation_id : string ; created_at : string ; credential_manager_acs_system_id : string ; user_identity_id : string ; workspace_id : string ; } ; } acs_ credential_ provisioning_ automation : { acs_credential_provisioning_automation_id : string ; created_at : string ; credential_manager_acs_system_id : string ; user_identity_id : string ; workspace_id : string ; } acs_ credential_ provisioning_ automation_ id : string created_ at : string credential_ manager_ acs_ system_ id : string user_ identity_ id : string workspace_ id : string method : "POST" query Params : {} route : "/acs/credential_provisioning_automations/launch" Defined in src/lib/seam/connect/route-types.ts:819 /acs/credentials/assign /acs/credentials/assign : { commonParams : {} ; formData : {} ; jsonBody : { acs_credential_id : string ; acs_user_id : string ; } ; jsonResponse : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/acs/credentials/assign" ; }
Type declaration common Params : {} form Data : {} json Body : { acs_credential_id : string ; acs_user_id : string ; } acs_ credential_ id : string acs_ user_ id : string json Response : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } acs_ credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } access_ method : "code" | "card" | "mobile_key" acs_ credential_ id : string Optional
acs_ credential_ pool_ id ?: string acs_ system_ id : string Optional
acs_ user_ id ?: string Optional
code ?: null | string created_ at : string display_ name : string Optional
ends_ at ?: string errors : { error_code : string ; message : string ; } [] Optional
external_ type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" Optional
external_ type_ display_ name ?: string Optional
is_ multi_ phone_ sync_ credential ?: boolean Optional
parent_ acs_ credential_ id ?: string Optional
starts_ at ?: string Optional
visionline_ metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } Optional
common_ acs_ entrance_ ids ?: string [] Optional
guest_ acs_ entrance_ ids ?: string [] Optional
joiner_ acs_ credential_ ids ?: string [] warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "POST" | "PATCH" query Params : {} route : "/acs/credentials/assign" Defined in src/lib/seam/connect/route-types.ts:842 /acs/credentials/create /acs/credentials/create : { commonParams : { access_method : "code" | "card" | "mobile_key" ; acs_user_id : string ; allowed_acs_entrance_ids ?: string [] ; code ?: string ; credential_manager_acs_system_id ?: string ; ends_at ?: string ; is_multi_phone_sync_credential ?: boolean ; starts_at ?: string ; visionline_metadata ?: { assa_abloy_credential_service_mobile_endpoint_id ?: string ; card_format ?: "TLCode" | "rfid48" ; is_override_key ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/acs/credentials/create" ; }
Type declaration common Params : { access_method : "code" | "card" | "mobile_key" ; acs_user_id : string ; allowed_acs_entrance_ids ?: string [] ; code ?: string ; credential_manager_acs_system_id ?: string ; ends_at ?: string ; is_multi_phone_sync_credential ?: boolean ; starts_at ?: string ; visionline_metadata ?: { assa_abloy_credential_service_mobile_endpoint_id ?: string ; card_format ?: "TLCode" | "rfid48" ; is_override_key ?: boolean ; joiner_acs_credential_ids ?: string [] ; } ; } access_ method : "code" | "card" | "mobile_key" acs_ user_ id : string Optional
allowed_ acs_ entrance_ ids ?: string [] Optional
code ?: string Optional
credential_ manager_ acs_ system_ id ?: string Optional
ends_ at ?: string Optional
is_ multi_ phone_ sync_ credential ?: boolean Optional
starts_ at ?: string Optional
visionline_ metadata ?: { assa_abloy_credential_service_mobile_endpoint_id ?: string ; card_format ?: "TLCode" | "rfid48" ; is_override_key ?: boolean ; joiner_acs_credential_ids ?: string [] ; } Optional
assa_ abloy_ credential_ service_ mobile_ endpoint_ id ?: string Optional
card_ format ?: "TLCode" | "rfid48" Optional
is_ override_ key ?: boolean Optional
joiner_ acs_ credential_ ids ?: string [] form Data : {} json Body : {} json Response : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } acs_ credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } access_ method : "code" | "card" | "mobile_key" acs_ credential_ id : string Optional
acs_ credential_ pool_ id ?: string acs_ system_ id : string Optional
acs_ user_ id ?: string Optional
code ?: null | string created_ at : string display_ name : string Optional
ends_ at ?: string errors : { error_code : string ; message : string ; } [] Optional
external_ type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" Optional
external_ type_ display_ name ?: string Optional
is_ multi_ phone_ sync_ credential ?: boolean Optional
parent_ acs_ credential_ id ?: string Optional
starts_ at ?: string Optional
visionline_ metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } Optional
common_ acs_ entrance_ ids ?: string [] Optional
guest_ acs_ entrance_ ids ?: string [] Optional
joiner_ acs_ credential_ ids ?: string [] warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "POST" query Params : {} route : "/acs/credentials/create" Defined in src/lib/seam/connect/route-types.ts:894 /acs/credentials/delete /acs/credentials/delete : { commonParams : { acs_credential_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/acs/credentials/delete" ; }
Type declaration common Params : { acs_credential_id : string ; } acs_ credential_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/acs/credentials/delete" Defined in src/lib/seam/connect/route-types.ts:962 /acs/credentials/get /acs/credentials/get : { commonParams : { acs_credential_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/credentials/get" ; }
Type declaration common Params : { acs_credential_id : string ; } acs_ credential_ id : string form Data : {} json Body : {} json Response : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } acs_ credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } access_ method : "code" | "card" | "mobile_key" acs_ credential_ id : string Optional
acs_ credential_ pool_ id ?: string acs_ system_ id : string Optional
acs_ user_ id ?: string Optional
code ?: null | string created_ at : string display_ name : string Optional
ends_ at ?: string errors : { error_code : string ; message : string ; } [] Optional
external_ type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" Optional
external_ type_ display_ name ?: string Optional
is_ multi_ phone_ sync_ credential ?: boolean Optional
parent_ acs_ credential_ id ?: string Optional
starts_ at ?: string Optional
visionline_ metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } Optional
common_ acs_ entrance_ ids ?: string [] Optional
guest_ acs_ entrance_ ids ?: string [] Optional
joiner_ acs_ credential_ ids ?: string [] warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "GET" | "POST" query Params : {} route : "/acs/credentials/get" Defined in src/lib/seam/connect/route-types.ts:973 /acs/credentials/list /acs/credentials/list : { commonParams : ( { acs_user_id : string ; } | { acs_system_id : string ; } | { acs_system_id : string ; acs_user_id : string ; } | { user_identity_id : string ; } ) & { is_multi_phone_sync_credential ?: boolean ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/credentials/list" ; }
Type declaration common Params : ( { acs_user_id : string ; } | { acs_system_id : string ; } | { acs_system_id : string ; acs_user_id : string ; } | { user_identity_id : string ; } ) & { is_multi_phone_sync_credential ?: boolean ; } form Data : {} json Body : {} json Response : { acs_credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } acs_ credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/acs/credentials/list" Defined in src/lib/seam/connect/route-types.ts:1024 /acs/credentials/unassign /acs/credentials/unassign : { commonParams : {} ; formData : {} ; jsonBody : { acs_credential_id : string ; acs_user_id : string ; } ; jsonResponse : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/acs/credentials/unassign" ; }
Type declaration common Params : {} form Data : {} json Body : { acs_credential_id : string ; acs_user_id : string ; } acs_ credential_ id : string acs_ user_ id : string json Response : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } acs_ credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } access_ method : "code" | "card" | "mobile_key" acs_ credential_ id : string Optional
acs_ credential_ pool_ id ?: string acs_ system_ id : string Optional
acs_ user_ id ?: string Optional
code ?: null | string created_ at : string display_ name : string Optional
ends_ at ?: string errors : { error_code : string ; message : string ; } [] Optional
external_ type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" Optional
external_ type_ display_ name ?: string Optional
is_ multi_ phone_ sync_ credential ?: boolean Optional
parent_ acs_ credential_ id ?: string Optional
starts_ at ?: string Optional
visionline_ metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } Optional
common_ acs_ entrance_ ids ?: string [] Optional
guest_ acs_ entrance_ ids ?: string [] Optional
joiner_ acs_ credential_ ids ?: string [] warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "POST" | "PATCH" query Params : {} route : "/acs/credentials/unassign" Defined in src/lib/seam/connect/route-types.ts:1089 /acs/credentials/update /acs/credentials/update : { commonParams : {} ; formData : {} ; jsonBody : { acs_credential_id : string ; code : string ; } ; jsonResponse : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/acs/credentials/update" ; }
Type declaration common Params : {} form Data : {} json Body : { acs_credential_id : string ; code : string ; } acs_ credential_ id : string code : string json Response : { acs_credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } acs_ credential : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } access_ method : "code" | "card" | "mobile_key" acs_ credential_ id : string Optional
acs_ credential_ pool_ id ?: string acs_ system_ id : string Optional
acs_ user_ id ?: string Optional
code ?: null | string created_ at : string display_ name : string Optional
ends_ at ?: string errors : { error_code : string ; message : string ; } [] Optional
external_ type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" Optional
external_ type_ display_ name ?: string Optional
is_ multi_ phone_ sync_ credential ?: boolean Optional
parent_ acs_ credential_ id ?: string Optional
starts_ at ?: string Optional
visionline_ metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } Optional
common_ acs_ entrance_ ids ?: string [] Optional
guest_ acs_ entrance_ ids ?: string [] Optional
joiner_ acs_ credential_ ids ?: string [] warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "POST" | "PATCH" query Params : {} route : "/acs/credentials/update" Defined in src/lib/seam/connect/route-types.ts:1141 /acs/entrances/get /acs/entrances/get : { commonParams : { acs_entrance_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_entrance : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/entrances/get" ; }
Type declaration common Params : { acs_entrance_id : string ; } form Data : {} json Body : {} json Response : { acs_entrance : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } ; } acs_ entrance : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } acs_ entrance_ id : string acs_ system_ id : string created_ at : string display_ name : string latch_ metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } visionline_ metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } method : "GET" | "POST" query Params : {} route : "/acs/entrances/get" Defined in src/lib/seam/connect/route-types.ts:1193 /acs/entrances/grant_ access /acs/entrances/grant_ access : { commonParams : {} ; formData : {} ; jsonBody : { acs_entrance_id : string ; acs_user_id : string ; } ; jsonResponse : {} ; method : "POST" ; queryParams : {} ; route : "/acs/entrances/grant_access" ; }
Type declaration common Params : {} form Data : {} json Body : { acs_entrance_id : string ; acs_user_id : string ; } acs_ entrance_ id : string acs_ user_ id : string json Response : {} method : "POST" query Params : {} route : "/acs/entrances/grant_access" Defined in src/lib/seam/connect/route-types.ts:1232 /acs/entrances/list /acs/entrances/list : { commonParams : { acs_credential_id ?: string ; acs_system_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_entrances : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/entrances/list" ; }
Type declaration common Params : { acs_credential_id ?: string ; acs_system_id ?: string ; } Optional
acs_ credential_ id ?: string Optional
acs_ system_ id ?: string form Data : {} json Body : {} json Response : { acs_entrances : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } [] ; } acs_ entrances : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } [] method : "GET" | "POST" query Params : {} route : "/acs/entrances/list" Defined in src/lib/seam/connect/route-types.ts:1244 /acs/entrances/list_ credentials_ with_ access /acs/entrances/list_ credentials_ with_ access : { commonParams : { acs_entrance_id : string ; include_if ?: "visionline_metadata.is_valid" [] ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/entrances/list_credentials_with_access" ; }
Type declaration common Params : { acs_entrance_id : string ; include_if ?: "visionline_metadata.is_valid" [] ; } acs_ entrance_ id : string Optional
include_ if ?: "visionline_metadata.is_valid" [] form Data : {} json Body : {} json Response : { acs_credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } acs_ credentials : { access_method : "code" | "card" | "mobile_key" ; acs_credential_id : string ; acs_credential_pool_id ?: string ; acs_system_id : string ; acs_user_id ?: string ; code ?: null | string ; created_at : string ; display_name : string ; ends_at ?: string ; errors : { error_code : string ; message : string ; } [] ; external_type ?: "pti_card" | "brivo_credential" | "hid_credential" | "visionline_card" ; external_type_display_name ?: string ; is_multi_phone_sync_credential ?: boolean ; parent_acs_credential_id ?: string ; starts_at ?: string ; visionline_metadata ?: { common_acs_entrance_ids ?: string [] ; guest_acs_entrance_ids ?: string [] ; joiner_acs_credential_ids ?: string [] ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/acs/entrances/list_credentials_with_access" Defined in src/lib/seam/connect/route-types.ts:1284 /acs/systems/get /acs/systems/get : { commonParams : { acs_system_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_system : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/systems/get" ; }
Type declaration common Params : { acs_system_id : string ; } form Data : {} json Body : {} json Response : { acs_system : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } ; } acs_ system : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } acs_ system_ id : string Optional
can_ automate_ enrollment ?: boolean connected_ account_ ids : string [] created_ at : string Optional
external_ type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" Optional
external_ type_ display_ name ?: string image_ alt_ text : string image_ url : string name : string Optional
system_ type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" Optional
system_ type_ display_ name ?: string workspace_ id : string method : "GET" | "POST" query Params : {} route : "/acs/systems/get" Defined in src/lib/seam/connect/route-types.ts:1336 /acs/systems/list /acs/systems/list : { commonParams : { connected_account_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_systems : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/systems/list" ; }
Type declaration common Params : { connected_account_id ?: string ; } Optional
connected_ account_ id ?: string form Data : {} json Body : {} json Response : { acs_systems : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } [] ; } acs_ systems : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/acs/systems/list" Defined in src/lib/seam/connect/route-types.ts:1394 /acs/users/add_ to_ access_ group /acs/users/add_ to_ access_ group : { commonParams : { acs_access_group_id : string ; acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PUT" ; queryParams : {} ; route : "/acs/users/add_to_access_group" ; }
Type declaration common Params : { acs_access_group_id : string ; acs_user_id : string ; } acs_ access_ group_ id : string acs_ user_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "PUT" query Params : {} route : "/acs/users/add_to_access_group" Defined in src/lib/seam/connect/route-types.ts:1452 /acs/users/create /acs/users/create : { commonParams : {} ; formData : {} ; jsonBody : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_access_group_ids ?: string [] ; acs_system_id : string ; email ?: string ; email_address ?: string ; full_name ?: string ; phone_number ?: string ; user_identity_id ?: string ; } ; jsonResponse : { acs_user : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/acs/users/create" ; }
Type declaration common Params : {} form Data : {} json Body : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_access_group_ids ?: string [] ; acs_system_id : string ; email ?: string ; email_address ?: string ; full_name ?: string ; phone_number ?: string ; user_identity_id ?: string ; } Optional
access_ schedule ?: { ends_at : string ; starts_at : string ; } ends_ at : string starts_ at : string Optional
acs_ access_ group_ ids ?: string [] acs_ system_ id : string Optional
email ?: string Optional
email_ address ?: string Optional
full_ name ?: string Optional
phone_ number ?: string Optional
user_ identity_ id ?: string json Response : { acs_user : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } ; } acs_ user : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } Optional
access_ schedule ?: { ends_at : string ; starts_at : string ; } ends_ at : string starts_ at : string acs_ system_ id : string acs_ user_ id : string created_ at : string display_ name : string Optional
email ?: string Optional
email_ address ?: string Optional
external_ type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" Optional
external_ type_ display_ name ?: string Optional
full_ name ?: string Optional
hid_ acs_ system_ id ?: string is_ suspended : boolean Optional
phone_ number ?: string Optional
user_ identity_ email_ address ?: null | string Optional
user_ identity_ full_ name ?: null | string Optional
user_ identity_ id ?: string Optional
user_ identity_ phone_ number ?: null | string workspace_ id : string method : "POST" query Params : {} route : "/acs/users/create" Defined in src/lib/seam/connect/route-types.ts:1464 /acs/users/delete /acs/users/delete : { commonParams : { acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/acs/users/delete" ; }
Type declaration common Params : { acs_user_id : string ; } form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/acs/users/delete" Defined in src/lib/seam/connect/route-types.ts:1531 /acs/users/get /acs/users/get : { commonParams : { acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_user : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/users/get" ; }
Type declaration common Params : { acs_user_id : string ; } form Data : {} json Body : {} json Response : { acs_user : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } ; } acs_ user : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } Optional
access_ schedule ?: { ends_at : string ; starts_at : string ; } ends_ at : string starts_ at : string acs_ system_ id : string acs_ user_ id : string created_ at : string display_ name : string Optional
email ?: string Optional
email_ address ?: string Optional
external_ type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" Optional
external_ type_ display_ name ?: string Optional
full_ name ?: string Optional
hid_ acs_ system_ id ?: string is_ suspended : boolean Optional
phone_ number ?: string Optional
user_ identity_ email_ address ?: null | string Optional
user_ identity_ full_ name ?: null | string Optional
user_ identity_ id ?: string Optional
user_ identity_ phone_ number ?: null | string workspace_ id : string method : "GET" | "POST" query Params : {} route : "/acs/users/get" Defined in src/lib/seam/connect/route-types.ts:1542 /acs/users/list /acs/users/list : { commonParams : { acs_system_id ?: string ; user_identity_email_address ?: string ; user_identity_id ?: string ; user_identity_phone_number ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/users/list" ; }
Type declaration common Params : { acs_system_id ?: string ; user_identity_email_address ?: string ; user_identity_id ?: string ; user_identity_phone_number ?: string ; } Optional
acs_ system_ id ?: string Optional
user_ identity_ email_ address ?: string Optional
user_ identity_ id ?: string Optional
user_ identity_ phone_ number ?: string form Data : {} json Body : {} json Response : { acs_users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] ; } acs_ users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/acs/users/list" Defined in src/lib/seam/connect/route-types.ts:1592 /acs/users/list_ accessible_ entrances /acs/users/list_ accessible_ entrances : { commonParams : { acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_entrances : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/acs/users/list_accessible_entrances" ; }
Type declaration common Params : { acs_user_id : string ; } form Data : {} json Body : {} json Response : { acs_entrances : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } [] ; } acs_ entrances : { acs_entrance_id : string ; acs_system_id : string ; created_at : string ; display_name : string ; latch_metadata : null | { accessibility_type : string ; is_connected : boolean ; name : string ; type : string ; } ; visionline_metadata : null | { door_category : "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)" ; door_name : string ; profiles ?: { visionline_door_profile_id : string ; visionline_door_profile_type : "BLE" | "commonDoor" | "touch" ; } [] ; } ; } [] method : "GET" | "POST" query Params : {} route : "/acs/users/list_accessible_entrances" Defined in src/lib/seam/connect/route-types.ts:1645 /acs/users/remove_ from_ access_ group /acs/users/remove_ from_ access_ group : { commonParams : { acs_access_group_id : string ; acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/acs/users/remove_from_access_group" ; }
Type declaration common Params : { acs_access_group_id : string ; acs_user_id : string ; } acs_ access_ group_ id : string acs_ user_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/acs/users/remove_from_access_group" Defined in src/lib/seam/connect/route-types.ts:1684 /acs/users/revoke_ access_ to_ all_ entrances /acs/users/revoke_ access_ to_ all_ entrances : { commonParams : {} ; formData : {} ; jsonBody : { acs_user_id : string ; } ; jsonResponse : {} ; method : "POST" ; queryParams : {} ; route : "/acs/users/revoke_access_to_all_entrances" ; }
Type declaration common Params : {} form Data : {} json Body : { acs_user_id : string ; } json Response : {} method : "POST" query Params : {} route : "/acs/users/revoke_access_to_all_entrances" Defined in src/lib/seam/connect/route-types.ts:1696 /acs/users/suspend /acs/users/suspend : { commonParams : { acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" ; queryParams : {} ; route : "/acs/users/suspend" ; }
Type declaration common Params : { acs_user_id : string ; } form Data : {} json Body : {} json Response : {} method : "POST" query Params : {} route : "/acs/users/suspend" Defined in src/lib/seam/connect/route-types.ts:1707 /acs/users/unsuspend /acs/users/unsuspend : { commonParams : { acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" ; queryParams : {} ; route : "/acs/users/unsuspend" ; }
Type declaration common Params : { acs_user_id : string ; } form Data : {} json Body : {} json Response : {} method : "POST" query Params : {} route : "/acs/users/unsuspend" Defined in src/lib/seam/connect/route-types.ts:1718 /acs/users/update /acs/users/update : { commonParams : {} ; formData : {} ; jsonBody : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_user_id : string ; email ?: string ; email_address ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; phone_number ?: string ; } ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/acs/users/update" ; }
Type declaration common Params : {} form Data : {} json Body : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_user_id : string ; email ?: string ; email_address ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; phone_number ?: string ; } Optional
access_ schedule ?: { ends_at : string ; starts_at : string ; } ends_ at : string starts_ at : string acs_ user_ id : string Optional
email ?: string Optional
email_ address ?: string Optional
full_ name ?: string Optional
hid_ acs_ system_ id ?: string Optional
phone_ number ?: string json Response : {} method : "POST" | "PATCH" query Params : {} route : "/acs/users/update" Defined in src/lib/seam/connect/route-types.ts:1729 /action_ attempts/get /action_ attempts/get : { commonParams : { action_attempt_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/action_attempts/get" ; }
Type declaration common Params : { action_attempt_id : string ; } action_ attempt_ id : string form Data : {} json Body : {} json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "GET" | "POST" query Params : {} route : "/action_attempts/get" Defined in src/lib/seam/connect/route-types.ts:1756 /action_ attempts/list /action_ attempts/list : { commonParams : { action_attempt_ids : string [] ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { action_attempts : ( { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ) [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/action_attempts/list" ; }
Type declaration common Params : { action_attempt_ids : string [] ; } action_ attempt_ ids : string [] form Data : {} json Body : {} json Response : { action_attempts : ( { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ) [] ; } action_ attempts : ( { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ) [] method : "GET" | "POST" query Params : {} route : "/action_attempts/list" Defined in src/lib/seam/connect/route-types.ts:1793 /client_ sessions/create /client_ sessions/create : { commonParams : {} ; formData : {} ; jsonBody : { connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; expires_at ?: Date ; user_identifier_key ?: string ; user_identity_ids ?: string [] ; } ; jsonResponse : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } ; method : "POST" | "PUT" ; queryParams : {} ; route : "/client_sessions/create" ; }
Type declaration common Params : {} form Data : {} json Body : { connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; expires_at ?: Date ; user_identifier_key ?: string ; user_identity_ids ?: string [] ; } Optional
connect_ webview_ ids ?: string [] Optional
connected_ account_ ids ?: string [] Optional
expires_ at ?: Date Optional
user_ identifier_ key ?: string Optional
user_ identity_ ids ?: string [] json Response : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } client_ session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } client_ session_ id : string connect_ webview_ ids : string [] connected_ account_ ids : string [] created_ at : string device_ count : number token : string user_ identifier_ key : null | string user_ identity_ ids : string [] workspace_ id : string method : "POST" | "PUT" query Params : {} route : "/client_sessions/create" Defined in src/lib/seam/connect/route-types.ts:1831 /client_ sessions/delete /client_ sessions/delete : { commonParams : { client_session_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/client_sessions/delete" ; }
Type declaration common Params : { client_session_id : string ; } client_ session_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/client_sessions/delete" Defined in src/lib/seam/connect/route-types.ts:1858 /client_ sessions/get /client_ sessions/get : { commonParams : { client_session_id ?: string ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/client_sessions/get" ; }
Type declaration common Params : { client_session_id ?: string ; user_identifier_key ?: string ; } Optional
client_ session_ id ?: string Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } client_ session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } client_ session_ id : string connect_ webview_ ids : string [] connected_ account_ ids : string [] created_ at : string device_ count : number token : string user_ identifier_ key : null | string user_ identity_ ids : string [] workspace_ id : string method : "GET" | "POST" query Params : {} route : "/client_sessions/get" Defined in src/lib/seam/connect/route-types.ts:1869 /client_ sessions/get_ or_ create /client_ sessions/get_ or_ create : { commonParams : {} ; formData : {} ; jsonBody : { connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; expires_at ?: Date ; user_identifier_key ?: string ; user_identity_ids ?: string [] ; } ; jsonResponse : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } ; method : "POST" | "PUT" ; queryParams : {} ; route : "/client_sessions/get_or_create" ; }
Type declaration common Params : {} form Data : {} json Body : { connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; expires_at ?: Date ; user_identifier_key ?: string ; user_identity_ids ?: string [] ; } Optional
connect_ webview_ ids ?: string [] Optional
connected_ account_ ids ?: string [] Optional
expires_ at ?: Date Optional
user_ identifier_ key ?: string Optional
user_ identity_ ids ?: string [] json Response : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } client_ session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } client_ session_ id : string connect_ webview_ ids : string [] connected_ account_ ids : string [] created_ at : string device_ count : number token : string user_ identifier_ key : null | string user_ identity_ ids : string [] workspace_ id : string method : "POST" | "PUT" query Params : {} route : "/client_sessions/get_or_create" Defined in src/lib/seam/connect/route-types.ts:1893 /client_ sessions/grant_ access /client_ sessions/grant_ access : { commonParams : { client_session_id ?: string ; connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; user_identifier_key ?: string ; user_identity_ids ?: string [] ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/client_sessions/grant_access" ; }
Type declaration common Params : { client_session_id ?: string ; connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; user_identifier_key ?: string ; user_identity_ids ?: string [] ; } Optional
client_ session_ id ?: string Optional
connect_ webview_ ids ?: string [] Optional
connected_ account_ ids ?: string [] Optional
user_ identifier_ key ?: string Optional
user_ identity_ ids ?: string [] form Data : {} json Body : {} json Response : { client_session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } ; } client_ session : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } client_ session_ id : string connect_ webview_ ids : string [] connected_ account_ ids : string [] created_ at : string device_ count : number token : string user_ identifier_ key : null | string user_ identity_ ids : string [] workspace_ id : string method : "POST" | "PATCH" query Params : {} route : "/client_sessions/grant_access" Defined in src/lib/seam/connect/route-types.ts:1920 /client_ sessions/list /client_ sessions/list : { commonParams : { client_session_id ?: string ; connect_webview_id ?: string ; user_identifier_key ?: string ; user_identity_id ?: string ; without_user_identifier_key ?: boolean ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { client_sessions : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/client_sessions/list" ; }
Type declaration common Params : { client_session_id ?: string ; connect_webview_id ?: string ; user_identifier_key ?: string ; user_identity_id ?: string ; without_user_identifier_key ?: boolean ; } Optional
client_ session_ id ?: string Optional
connect_ webview_ id ?: string Optional
user_ identifier_ key ?: string Optional
user_ identity_ id ?: string Optional
without_ user_ identifier_ key ?: boolean form Data : {} json Body : {} json Response : { client_sessions : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } [] ; } client_ sessions : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; token : string ; user_identifier_key : null | string ; user_identity_ids : string [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/client_sessions/list" Defined in src/lib/seam/connect/route-types.ts:1947 /client_ sessions/revoke /client_ sessions/revoke : { commonParams : { client_session_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" ; queryParams : {} ; route : "/client_sessions/revoke" ; }
Type declaration common Params : { client_session_id : string ; } client_ session_ id : string form Data : {} json Body : {} json Response : {} method : "POST" query Params : {} route : "/client_sessions/revoke" Defined in src/lib/seam/connect/route-types.ts:1974 /connect_ webviews/create /connect_ webviews/create : { commonParams : {} ; formData : {} ; jsonBody : { accepted_providers ?: ( "linear" | "assa_abloy_credential_service" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "noiseaware" | "nuki" | "seam_relay_admin" | "igloo" | "kwikset" | "minut" | "my_2n" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "pti" | "wyze" | "seam_passport" | "visionline" | "seam_bridge" | "tedee" | "honeywell_resideo" | "latch" | "yale_access" | "hid_cm" | "google_nest" ) [] ; automatically_manage_new_devices ?: boolean ; custom_metadata ?: Record < string , null | string | boolean > ; custom_redirect_failure_url ?: string ; custom_redirect_url ?: string ; device_selection_mode ?: "none" | "multiple" | "single" ; provider_category ?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta" ; wait_for_device_creation ?: boolean ; } ; jsonResponse : { connect_webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/connect_webviews/create" ; }
Type declaration common Params : {} form Data : {} json Body : { accepted_providers ?: ( "linear" | "assa_abloy_credential_service" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "noiseaware" | "nuki" | "seam_relay_admin" | "igloo" | "kwikset" | "minut" | "my_2n" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "pti" | "wyze" | "seam_passport" | "visionline" | "seam_bridge" | "tedee" | "honeywell_resideo" | "latch" | "yale_access" | "hid_cm" | "google_nest" ) [] ; automatically_manage_new_devices ?: boolean ; custom_metadata ?: Record < string , null | string | boolean > ; custom_redirect_failure_url ?: string ; custom_redirect_url ?: string ; device_selection_mode ?: "none" | "multiple" | "single" ; provider_category ?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta" ; wait_for_device_creation ?: boolean ; } Optional
accepted_ providers ?: ( "linear" | "assa_abloy_credential_service" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "noiseaware" | "nuki" | "seam_relay_admin" | "igloo" | "kwikset" | "minut" | "my_2n" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "pti" | "wyze" | "seam_passport" | "visionline" | "seam_bridge" | "tedee" | "honeywell_resideo" | "latch" | "yale_access" | "hid_cm" | "google_nest" ) [] Optional
automatically_ manage_ new_ devices ?: boolean Optional
custom_ metadata ?: Record < string , null | string | boolean > Optional
custom_ redirect_ failure_ url ?: string Optional
custom_ redirect_ url ?: string Optional
device_ selection_ mode ?: "none" | "multiple" | "single" Optional
provider_ category ?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" | "internal_beta" Optional
wait_ for_ device_ creation ?: boolean json Response : { connect_webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } ; } connect_ webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } accepted_ devices : string [] accepted_ providers : string [] any_ device_ allowed : boolean any_ provider_ allowed : boolean authorized_ at : null | string automatically_ manage_ new_ devices : boolean connect_ webview_ id : string connected_ account_ id : null | string created_ at : string custom_ metadata : Record < string , string | boolean > custom_ redirect_ failure_ url : null | string custom_ redirect_ url : null | string device_ selection_ mode : "none" | "multiple" | "single" login_ successful : boolean selected_ provider : null | string status : "failed" | "pending" | "authorized" url : string wait_ for_ device_ creation : boolean workspace_ id : string method : "POST" query Params : {} route : "/connect_webviews/create" Defined in src/lib/seam/connect/route-types.ts:1985 /connect_ webviews/delete /connect_ webviews/delete : { commonParams : {} ; formData : {} ; jsonBody : { connect_webview_id : string ; } ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/connect_webviews/delete" ; }
Type declaration common Params : {} form Data : {} json Body : { connect_webview_id : string ; } connect_ webview_ id : string json Response : {} method : "POST" | "DELETE" query Params : {} route : "/connect_webviews/delete" Defined in src/lib/seam/connect/route-types.ts:2087 /connect_ webviews/get /connect_ webviews/get : { commonParams : { connect_webview_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { connect_webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/connect_webviews/get" ; }
Type declaration common Params : { connect_webview_id : string ; } connect_ webview_ id : string form Data : {} json Body : {} json Response : { connect_webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } ; } connect_ webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } accepted_ devices : string [] accepted_ providers : string [] any_ device_ allowed : boolean any_ provider_ allowed : boolean authorized_ at : null | string automatically_ manage_ new_ devices : boolean connect_ webview_ id : string connected_ account_ id : null | string created_ at : string custom_ metadata : Record < string , string | boolean > custom_ redirect_ failure_ url : null | string custom_ redirect_ url : null | string device_ selection_ mode : "none" | "multiple" | "single" login_ successful : boolean selected_ provider : null | string status : "failed" | "pending" | "authorized" url : string wait_ for_ device_ creation : boolean workspace_ id : string method : "GET" | "POST" query Params : {} route : "/connect_webviews/get" Defined in src/lib/seam/connect/route-types.ts:2098 /connect_ webviews/list /connect_ webviews/list : { commonParams : { custom_metadata_has ?: Record < string , string | boolean > ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { connect_webviews : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/connect_webviews/list" ; }
Type declaration common Params : { custom_metadata_has ?: Record < string , string | boolean > ; user_identifier_key ?: string ; } Optional
custom_ metadata_ has ?: Record < string , string | boolean > Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { connect_webviews : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } [] ; } connect_ webviews : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; authorized_at : null | string ; automatically_manage_new_devices : boolean ; connect_webview_id : string ; connected_account_id : null | string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; custom_redirect_failure_url : null | string ; custom_redirect_url : null | string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; selected_provider : null | string ; status : "failed" | "pending" | "authorized" ; url : string ; wait_for_device_creation : boolean ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/connect_webviews/list" Defined in src/lib/seam/connect/route-types.ts:2141 /connected_ accounts/delete /connected_ accounts/delete : { commonParams : {} ; formData : {} ; jsonBody : { connected_account_id : string ; sync ?: boolean ; } ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/connected_accounts/delete" ; }
Type declaration common Params : {} form Data : {} json Body : { connected_account_id : string ; sync ?: boolean ; } connected_ account_ id : string Optional
sync ?: boolean json Response : {} method : "POST" | "DELETE" query Params : {} route : "/connected_accounts/delete" Defined in src/lib/seam/connect/route-types.ts:2186 /connected_ accounts/get /connected_ accounts/get : { commonParams : { connected_account_id : string ; } | { email : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { connected_account : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/connected_accounts/get" ; }
Type declaration common Params : { connected_account_id : string ; } | { email : string ; } form Data : {} json Body : {} json Response : { connected_account : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } ; } connected_ account : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } Optional
account_ type ?: string account_ type_ display_ name : string automatically_ manage_ new_ devices : boolean Optional
connected_ account_ id ?: string Optional
created_ at ?: string custom_ metadata : Record < string , string | boolean > Optional
errors ?: any Optional
user_ identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } Optional
api_ url ?: string Optional
email ?: string Optional
exclusive ?: boolean Optional
phone ?: string Optional
username ?: string Optional
warnings ?: any method : "GET" | "POST" query Params : {} route : "/connected_accounts/get" Defined in src/lib/seam/connect/route-types.ts:2198 /connected_ accounts/list /connected_ accounts/list : { commonParams : { custom_metadata_has ?: Record < string , string | boolean > ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { connected_accounts : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/connected_accounts/list" ; }
Type declaration common Params : { custom_metadata_has ?: Record < string , string | boolean > ; } Optional
custom_ metadata_ has ?: Record < string , string | boolean > form Data : {} json Body : {} json Response : { connected_accounts : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } [] ; } connected_ accounts : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } [] method : "GET" | "POST" query Params : {} route : "/connected_accounts/list" Defined in src/lib/seam/connect/route-types.ts:2233 /connected_ accounts/update /connected_ accounts/update : { commonParams : {} ; formData : {} ; jsonBody : { automatically_manage_new_devices ?: boolean ; connected_account_id : string ; custom_metadata ?: Record < string , null | string | boolean > ; } ; jsonResponse : { connected_account : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } ; } ; method : "POST" ; queryParams : {} ; route : "/connected_accounts/update" ; }
Type declaration common Params : {} form Data : {} json Body : { automatically_manage_new_devices ?: boolean ; connected_account_id : string ; custom_metadata ?: Record < string , null | string | boolean > ; } Optional
automatically_ manage_ new_ devices ?: boolean connected_ account_ id : string Optional
custom_ metadata ?: Record < string , null | string | boolean > json Response : { connected_account : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } ; } connected_ account : { account_type ?: string ; account_type_display_name : string ; automatically_manage_new_devices : boolean ; connected_account_id ?: string ; created_at ?: string ; custom_metadata : Record < string , string | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } Optional
account_ type ?: string account_ type_ display_ name : string automatically_ manage_ new_ devices : boolean Optional
connected_ account_ id ?: string Optional
created_ at ?: string custom_ metadata : Record < string , string | boolean > Optional
errors ?: any Optional
user_ identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } Optional
api_ url ?: string Optional
email ?: string Optional
exclusive ?: boolean Optional
phone ?: string Optional
username ?: string Optional
warnings ?: any method : "POST" query Params : {} route : "/connected_accounts/update" Defined in src/lib/seam/connect/route-types.ts:2265 /devices/delete /devices/delete : { commonParams : { device_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/devices/delete" ; }
Type declaration common Params : { device_id : string ; } form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/devices/delete" Defined in src/lib/seam/connect/route-types.ts:2298 /devices/get /devices/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/devices/get" ; }
Type declaration common Params : { device_id ?: string ; name ?: string ; } Optional
device_ id ?: string Optional
name ?: string form Data : {} json Body : {} json Response : { device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } Optional
can_ program_ online_ access_ codes ?: boolean Optional
can_ remotely_ lock ?: boolean Optional
can_ remotely_ unlock ?: boolean Optional
can_ simulate_ removal ?: boolean capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] connected_ account_ id : string created_ at : string custom_ metadata : Record < string , string | boolean > device_ id : string device_ type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" display_ name : string errors : { error_code : string ; message : string ; } [] is_ managed : true location : null | { location_name ?: string ; timezone ?: string ; } Optional
nickname ?: string properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "GET" | "POST" query Params : {} route : "/devices/get" Defined in src/lib/seam/connect/route-types.ts:2309 /devices/list /devices/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/devices/list" ; }
Type declaration common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } Optional
connect_ webview_ id ?: string Optional
connected_ account_ id ?: string Optional
connected_ account_ ids ?: string [] Optional
created_ before ?: Date Optional
custom_ metadata_ has ?: Record < string , string | boolean > Optional
device_ ids ?: string [] Optional
device_ type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" Optional
device_ types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] Optional
exclude_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
include_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
limit ?: number Optional
manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/devices/list" Defined in src/lib/seam/connect/route-types.ts:3050 /devices/list_ device_ providers /devices/list_ device_ providers : { commonParams : { provider_category ?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device_providers : { device_provider_name : "linear" | "assa_abloy_credential_service" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "noiseaware" | "nuki" | "seam_relay_admin" | "igloo" | "kwikset" | "minut" | "my_2n" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "pti" | "wyze" | "seam_passport" | "visionline" | "seam_bridge" | "tedee" | "honeywell_resideo" | "latch" ; display_name : string ; image_url : string ; provider_categories : ( "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" ) [] ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/devices/list_device_providers" ; }
Type declaration common Params : { provider_category ?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" ; } Optional
provider_ category ?: "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" form Data : {} json Body : {} json Response : { device_providers : { device_provider_name : "linear" | "assa_abloy_credential_service" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "noiseaware" | "nuki" | "seam_relay_admin" | "igloo" | "kwikset" | "minut" | "my_2n" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "pti" | "wyze" | "seam_passport" | "visionline" | "seam_bridge" | "tedee" | "honeywell_resideo" | "latch" ; display_name : string ; image_url : string ; provider_categories : ( "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" ) [] ; } [] ; } device_ providers : { device_provider_name : "linear" | "assa_abloy_credential_service" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "noiseaware" | "nuki" | "seam_relay_admin" | "igloo" | "kwikset" | "minut" | "my_2n" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "pti" | "wyze" | "seam_passport" | "visionline" | "seam_bridge" | "tedee" | "honeywell_resideo" | "latch" ; display_name : string ; image_url : string ; provider_categories : ( "stable" | "consumer_smartlocks" | "thermostats" | "noise_sensors" | "access_control_systems" ) [] ; } [] method : "GET" | "POST" query Params : {} route : "/devices/list_device_providers" Defined in src/lib/seam/connect/route-types.ts:3930 /devices/simulate/remove /devices/simulate/remove : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; } ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/devices/simulate/remove" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; } json Response : {} method : "POST" | "DELETE" query Params : {} route : "/devices/simulate/remove" Defined in src/lib/seam/connect/route-types.ts:3999 /devices/unmanaged/get /devices/unmanaged/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/devices/unmanaged/get" ; }
Type declaration common Params : { device_id ?: string ; name ?: string ; } Optional
device_ id ?: string Optional
name ?: string form Data : {} json Body : {} json Response : { device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } Optional
can_ program_ online_ access_ codes ?: boolean Optional
can_ remotely_ lock ?: boolean Optional
can_ remotely_ unlock ?: boolean Optional
can_ simulate_ removal ?: boolean capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] connected_ account_ id : string created_ at : string device_ id : string device_ type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" errors : { error_code : string ; message : string ; } [] is_ managed : false properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; } Optional
accessory_ keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } Optional
battery ?: { level : number ; } is_ connected : boolean Optional
battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } level : number status : "low" | "full" | "critical" | "good" Optional
battery_ level ?: number Optional
image_ alt_ text ?: string Optional
image_ url ?: string Optional
manufacturer ?: string model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } Optional
accessory_ keypad_ supported ?: boolean Optional
can_ connect_ accessory_ keypad ?: boolean display_ name : string Optional
has_ built_ in_ keypad ?: boolean manufacturer_ display_ name : string Optional
offline_ access_ codes_ supported ?: boolean Optional
online_ access_ codes_ supported ?: boolean name : string Optional
offline_ access_ codes_ enabled ?: boolean online : boolean Optional
online_ access_ codes_ enabled ?: boolean warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "GET" | "POST" query Params : {} route : "/devices/unmanaged/get" Defined in src/lib/seam/connect/route-types.ts:4010 /devices/unmanaged/list /devices/unmanaged/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/devices/unmanaged/list" ; }
Type declaration common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } Optional
connect_ webview_ id ?: string Optional
connected_ account_ id ?: string Optional
connected_ account_ ids ?: string [] Optional
created_ before ?: Date Optional
custom_ metadata_ has ?: Record < string , string | boolean > Optional
device_ ids ?: string [] Optional
device_ type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" Optional
device_ types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] Optional
exclude_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
include_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
limit ?: number Optional
manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/devices/unmanaged/list" Defined in src/lib/seam/connect/route-types.ts:4153 /devices/unmanaged/update /devices/unmanaged/update : { commonParams : { device_id : string ; is_managed : true ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/devices/unmanaged/update" ; }
Type declaration common Params : { device_id : string ; is_managed : true ; } device_ id : string is_ managed : true form Data : {} json Body : {} json Response : {} method : "POST" | "PATCH" query Params : {} route : "/devices/unmanaged/update" Defined in src/lib/seam/connect/route-types.ts:4435 /devices/update /devices/update : { commonParams : { custom_metadata ?: Record < string , null | string | boolean > ; device_id : string ; is_managed ?: boolean ; name ?: null | string ; properties ?: { name ?: null | string ; } ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/devices/update" ; }
Type declaration common Params : { custom_metadata ?: Record < string , null | string | boolean > ; device_id : string ; is_managed ?: boolean ; name ?: null | string ; properties ?: { name ?: null | string ; } ; } Optional
custom_ metadata ?: Record < string , null | string | boolean > device_ id : string Optional
is_ managed ?: boolean Optional
name ?: null | string Optional
properties ?: { name ?: null | string ; } Optional
name ?: null | string form Data : {} json Body : {} json Response : {} method : "POST" | "PATCH" query Params : {} route : "/devices/update" Defined in src/lib/seam/connect/route-types.ts:4447 /events/get /events/get : { commonParams : { device_id ?: string ; event_id ?: string ; event_type ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { event ?: { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } ; message ?: string ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/events/get" ; }
Type declaration common Params : { device_id ?: string ; event_id ?: string ; event_type ?: string ; } Optional
device_ id ?: string Optional
event_ id ?: string Optional
event_ type ?: string form Data : {} json Body : {} json Response : { event ?: { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } ; message ?: string ; } Optional
event ?: { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } created_ at : string Optional
device_ id ?: string event_ id : string event_ type : string occurred_ at : string workspace_ id : string Optional
message ?: string method : "GET" | "POST" query Params : {} route : "/events/get" Defined in src/lib/seam/connect/route-types.ts:4466 /events/list /events/list : { commonParams : { access_code_id ?: string ; access_code_ids ?: string [] ; between ?: ( string | Date ) [] ; connected_account_id ?: string ; device_id ?: string ; device_ids ?: string [] ; event_type ?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.deleted" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "phone.deactivated" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.completed_first_sync_after_reconnection" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" | "acs_user.deleted" | "acs_credential.deleted" | "enrollment_automation.deleted" | "client_session.deleted" ; event_types ?: ( "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.deleted" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "phone.deactivated" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.completed_first_sync_after_reconnection" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" | "acs_user.deleted" | "acs_credential.deleted" | "enrollment_automation.deleted" | "client_session.deleted" ) [] ; limit ?: number ; since ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { events : { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/events/list" ; }
Type declaration common Params : { access_code_id ?: string ; access_code_ids ?: string [] ; between ?: ( string | Date ) [] ; connected_account_id ?: string ; device_id ?: string ; device_ids ?: string [] ; event_type ?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.deleted" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "phone.deactivated" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.completed_first_sync_after_reconnection" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" | "acs_user.deleted" | "acs_credential.deleted" | "enrollment_automation.deleted" | "client_session.deleted" ; event_types ?: ( "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.deleted" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "phone.deactivated" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.completed_first_sync_after_reconnection" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" | "acs_user.deleted" | "acs_credential.deleted" | "enrollment_automation.deleted" | "client_session.deleted" ) [] ; limit ?: number ; since ?: string ; } Optional
access_ code_ id ?: string Optional
access_ code_ ids ?: string [] Optional
between ?: ( string | Date ) [] Optional
connected_ account_ id ?: string Optional
device_ id ?: string Optional
device_ ids ?: string [] Optional
event_ type ?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.deleted" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "phone.deactivated" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.completed_first_sync_after_reconnection" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" | "acs_user.deleted" | "acs_credential.deleted" | "enrollment_automation.deleted" | "client_session.deleted" Optional
event_ types ?: ( "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.deleted" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "device.third_party_integration_detected" | "device.third_party_integration_no_longer_detected" | "device.salto.privacy_mode_activated" | "device.salto.privacy_mode_deactivated" | "device.connection_became_flaky" | "device.connection_stabilized" | "device.error.subscription_required" | "device.error.subscription_required.resolved" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "phone.deactivated" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "connected_account.completed_first_sync_after_reconnection" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" | "acs_user.deleted" | "acs_credential.deleted" | "enrollment_automation.deleted" | "client_session.deleted" ) [] Optional
limit ?: number Optional
since ?: string form Data : {} json Body : {} json Response : { events : { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } [] ; } events : { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/events/list" Defined in src/lib/seam/connect/route-types.ts:4491 /locks/get /locks/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; lock : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/locks/get" ; }
Type declaration common Params : { device_id ?: string ; name ?: string ; } Optional
device_ id ?: string Optional
name ?: string form Data : {} json Body : {} json Response : { device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; lock : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } device : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } Optional
can_ program_ online_ access_ codes ?: boolean Optional
can_ remotely_ lock ?: boolean Optional
can_ remotely_ unlock ?: boolean Optional
can_ simulate_ removal ?: boolean capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] connected_ account_ id : string created_ at : string custom_ metadata : Record < string , string | boolean > device_ id : string device_ type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" display_ name : string errors : { error_code : string ; message : string ; } [] is_ managed : true location : null | { location_name ?: string ; timezone ?: string ; } Optional
nickname ?: string properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) warnings : { message : string ; warning_code : string ; } [] workspace_ id : string lock : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } Optional
can_ program_ online_ access_ codes ?: boolean Optional
can_ remotely_ lock ?: boolean Optional
can_ remotely_ unlock ?: boolean Optional
can_ simulate_ removal ?: boolean capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] connected_ account_ id : string created_ at : string custom_ metadata : Record < string , string | boolean > device_ id : string device_ type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" display_ name : string errors : { error_code : string ; message : string ; } [] is_ managed : true location : null | { location_name ?: string ; timezone ?: string ; } Optional
nickname ?: string properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "GET" | "POST" query Params : {} route : "/locks/get" Defined in src/lib/seam/connect/route-types.ts:4628 /locks/list /locks/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; locks : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/locks/list" ; }
Type declaration common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } Optional
connect_ webview_ id ?: string Optional
connected_ account_ id ?: string Optional
connected_ account_ ids ?: string [] Optional
created_ before ?: Date Optional
custom_ metadata_ has ?: Record < string , string | boolean > Optional
device_ ids ?: string [] Optional
device_ type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" Optional
device_ types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] Optional
exclude_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
include_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
limit ?: number Optional
manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; locks : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] locks : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/locks/list" Defined in src/lib/seam/connect/route-types.ts:6097 /locks/lock_ door /locks/lock_ door : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/locks/lock_door" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; sync ?: boolean ; } device_ id : string Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/locks/lock_door" Defined in src/lib/seam/connect/route-types.ts:7705 /locks/unlock_ door /locks/unlock_ door : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/locks/unlock_door" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; sync ?: boolean ; } device_ id : string Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/locks/unlock_door" Defined in src/lib/seam/connect/route-types.ts:7743 /networks/get /networks/get : { commonParams : { network_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { network : { created_at : string ; display_name : string ; network_id : string ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/networks/get" ; }
Type declaration common Params : { network_id : string ; } form Data : {} json Body : {} json Response : { network : { created_at : string ; display_name : string ; network_id : string ; workspace_id : string ; } ; } network : { created_at : string ; display_name : string ; network_id : string ; workspace_id : string ; } created_ at : string display_ name : string network_ id : string workspace_ id : string method : "GET" | "POST" query Params : {} route : "/networks/get" Defined in src/lib/seam/connect/route-types.ts:7781 /networks/list /networks/list : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { networks : { created_at : string ; display_name : string ; network_id : string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/networks/list" ; }
Type declaration common Params : {} form Data : {} json Body : {} json Response : { networks : { created_at : string ; display_name : string ; network_id : string ; workspace_id : string ; } [] ; } networks : { created_at : string ; display_name : string ; network_id : string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/networks/list" Defined in src/lib/seam/connect/route-types.ts:7799 /noise_ sensors/noise_ thresholds/create /noise_ sensors/noise_ thresholds/create : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; ends_daily_at : string ; name ?: string ; noise_threshold_decibels ?: number ; noise_threshold_nrs ?: number ; starts_daily_at : string ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; noise_threshold : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/noise_sensors/noise_thresholds/create" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; ends_daily_at : string ; name ?: string ; noise_threshold_decibels ?: number ; noise_threshold_nrs ?: number ; starts_daily_at : string ; sync ?: boolean ; } device_ id : string ends_ daily_ at : string Optional
name ?: string Optional
noise_ threshold_ decibels ?: number Optional
noise_ threshold_ nrs ?: number starts_ daily_ at : string Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; noise_threshold : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } noise_ threshold : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } device_ id : string ends_ daily_ at : string name : string noise_ threshold_ decibels : number noise_ threshold_ id : string Optional
noise_ threshold_ nrs ?: number starts_ daily_ at : string method : "POST" query Params : {} route : "/noise_sensors/noise_thresholds/create" Defined in src/lib/seam/connect/route-types.ts:7815 /noise_ sensors/noise_ thresholds/delete /noise_ sensors/noise_ thresholds/delete : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; noise_threshold_id : string ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/noise_sensors/noise_thresholds/delete" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; noise_threshold_id : string ; sync ?: boolean ; } device_ id : string noise_ threshold_ id : string Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" | "DELETE" query Params : {} route : "/noise_sensors/noise_thresholds/delete" Defined in src/lib/seam/connect/route-types.ts:7867 /noise_ sensors/noise_ thresholds/get /noise_ sensors/noise_ thresholds/get : { commonParams : { noise_threshold_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { noise_threshold : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/noise_sensors/noise_thresholds/get" ; }
Type declaration common Params : { noise_threshold_id : string ; } noise_ threshold_ id : string form Data : {} json Body : {} json Response : { noise_threshold : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } ; } noise_ threshold : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } device_ id : string ends_ daily_ at : string name : string noise_ threshold_ decibels : number noise_ threshold_ id : string Optional
noise_ threshold_ nrs ?: number starts_ daily_ at : string method : "GET" | "POST" query Params : {} route : "/noise_sensors/noise_thresholds/get" Defined in src/lib/seam/connect/route-types.ts:7906 /noise_ sensors/noise_ thresholds/list /noise_ sensors/noise_ thresholds/list : { commonParams : { device_id : string ; is_programmed ?: boolean ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { noise_thresholds : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/noise_sensors/noise_thresholds/list" ; }
Type declaration common Params : { device_id : string ; is_programmed ?: boolean ; } device_ id : string Optional
is_ programmed ?: boolean form Data : {} json Body : {} json Response : { noise_thresholds : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } [] ; } noise_ thresholds : { device_id : string ; ends_daily_at : string ; name : string ; noise_threshold_decibels : number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at : string ; } [] method : "GET" | "POST" query Params : {} route : "/noise_sensors/noise_thresholds/list" Defined in src/lib/seam/connect/route-types.ts:7927 /noise_ sensors/noise_ thresholds/update /noise_ sensors/noise_ thresholds/update : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; ends_daily_at ?: string ; name ?: string ; noise_threshold_decibels ?: number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at ?: string ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" | "PUT" | "PATCH" ; queryParams : {} ; route : "/noise_sensors/noise_thresholds/update" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; ends_daily_at ?: string ; name ?: string ; noise_threshold_decibels ?: number ; noise_threshold_id : string ; noise_threshold_nrs ?: number ; starts_daily_at ?: string ; sync ?: boolean ; } device_ id : string Optional
ends_ daily_ at ?: string Optional
name ?: string Optional
noise_ threshold_ decibels ?: number noise_ threshold_ id : string Optional
noise_ threshold_ nrs ?: number Optional
starts_ daily_ at ?: string Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" | "PUT" | "PATCH" query Params : {} route : "/noise_sensors/noise_thresholds/update" Defined in src/lib/seam/connect/route-types.ts:7949 /noise_ sensors/simulate/trigger_ noise_ threshold /noise_ sensors/simulate/trigger_ noise_ threshold : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; } ; jsonResponse : {} ; method : "POST" ; queryParams : {} ; route : "/noise_sensors/simulate/trigger_noise_threshold" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; } json Response : {} method : "POST" query Params : {} route : "/noise_sensors/simulate/trigger_noise_threshold" Defined in src/lib/seam/connect/route-types.ts:7993 /phones/deactivate /phones/deactivate : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; } ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/phones/deactivate" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; } json Response : {} method : "POST" | "DELETE" query Params : {} route : "/phones/deactivate" Defined in src/lib/seam/connect/route-types.ts:8004 /phones/list /phones/list : { commonParams : { owner_user_identity_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { phones : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/phones/list" ; }
Type declaration common Params : { owner_user_identity_id ?: string ; } Optional
owner_ user_ identity_ id ?: string form Data : {} json Body : {} json Response : { phones : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } phones : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/phones/list" Defined in src/lib/seam/connect/route-types.ts:8015 /phones/simulate/create_ sandbox_ phone /phones/simulate/create_ sandbox_ phone : { commonParams : {} ; formData : {} ; jsonBody : { assa_abloy_metadata ?: { application_version ?: string ; ble_capability ?: boolean ; hce_capability ?: boolean ; nfc_capability ?: boolean ; seos_applet_version ?: string ; seos_tsm_endpoint_id ?: number ; } ; custom_sdk_installation_id ?: string ; phone_metadata ?: { device_manufacturer ?: string ; device_model ?: string ; operating_system ?: "android" | "ios" ; os_version ?: string ; } ; user_identity_id : string ; } ; jsonResponse : { phone : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/phones/simulate/create_sandbox_phone" ; }
Type declaration common Params : {} form Data : {} json Body : { assa_abloy_metadata ?: { application_version ?: string ; ble_capability ?: boolean ; hce_capability ?: boolean ; nfc_capability ?: boolean ; seos_applet_version ?: string ; seos_tsm_endpoint_id ?: number ; } ; custom_sdk_installation_id ?: string ; phone_metadata ?: { device_manufacturer ?: string ; device_model ?: string ; operating_system ?: "android" | "ios" ; os_version ?: string ; } ; user_identity_id : string ; } Optional
assa_ abloy_ metadata ?: { application_version ?: string ; ble_capability ?: boolean ; hce_capability ?: boolean ; nfc_capability ?: boolean ; seos_applet_version ?: string ; seos_tsm_endpoint_id ?: number ; } Optional
application_ version ?: string Optional
ble_ capability ?: boolean Optional
hce_ capability ?: boolean Optional
nfc_ capability ?: boolean Optional
seos_ applet_ version ?: string Optional
seos_ tsm_ endpoint_ id ?: number Optional
custom_ sdk_ installation_ id ?: string Optional
phone_ metadata ?: { device_manufacturer ?: string ; device_model ?: string ; operating_system ?: "android" | "ios" ; os_version ?: string ; } Optional
device_ manufacturer ?: string Optional
device_ model ?: string Optional
operating_ system ?: "android" | "ios" Optional
os_ version ?: string user_ identity_ id : string json Response : { phone : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } phone : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } Optional
can_ program_ online_ access_ codes ?: boolean Optional
can_ remotely_ lock ?: boolean Optional
can_ remotely_ unlock ?: boolean Optional
can_ simulate_ removal ?: boolean capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] created_ at : string custom_ metadata : Record < string , string | boolean > device_ id : string device_ type : "ios_phone" | "android_phone" display_ name : string errors : { error_code : string ; message : string ; } [] is_ managed : true location : null | { location_name ?: string ; timezone ?: string ; } Optional
nickname ?: string properties : { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } Optional
assa_ abloy_ credential_ service_ metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } endpoints : { endpoint_id : string ; is_active : boolean ; } [] has_ active_ endpoint : boolean warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "GET" | "POST" query Params : {} route : "/phones/simulate/create_sandbox_phone" Defined in src/lib/seam/connect/route-types.ts:8084 /thermostats/climate_ setting_ schedules/create /thermostats/climate_ setting_ schedules/create : { commonParams : {} ; formData : {} ; jsonBody : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; device_id : string ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type ?: "time_bound" ; } ; jsonResponse : { climate_setting_schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/thermostats/climate_setting_schedules/create" ; }
Type declaration common Params : {} form Data : {} json Body : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; device_id : string ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type ?: "time_bound" ; } Optional
automatic_ cooling_ enabled ?: boolean Optional
automatic_ heating_ enabled ?: boolean Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number device_ id : string Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
hvac_ mode_ setting ?: "off" | "heat" | "cool" | "heat_cool" Optional
manual_ override_ allowed ?: boolean Optional
name ?: string schedule_ ends_ at : string schedule_ starts_ at : string Optional
schedule_ type ?: "time_bound" json Response : { climate_setting_schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } ; } climate_ setting_ schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } Optional
automatic_ cooling_ enabled ?: boolean Optional
automatic_ heating_ enabled ?: boolean climate_ setting_ schedule_ id : string Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number created_ at : string device_ id : string Optional
errors ?: any Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
hvac_ mode_ setting ?: "off" | "heat" | "cool" | "heat_cool" Optional
manual_ override_ allowed ?: boolean Optional
name ?: string schedule_ ends_ at : string schedule_ starts_ at : string schedule_ type : "time_bound" method : "POST" query Params : {} route : "/thermostats/climate_setting_schedules/create" Defined in src/lib/seam/connect/route-types.ts:8168 /thermostats/climate_ setting_ schedules/delete /thermostats/climate_ setting_ schedules/delete : { commonParams : { climate_setting_schedule_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PUT" | "DELETE" ; queryParams : {} ; route : "/thermostats/climate_setting_schedules/delete" ; }
Type declaration common Params : { climate_setting_schedule_id : string ; } climate_ setting_ schedule_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "PUT" | "DELETE" query Params : {} route : "/thermostats/climate_setting_schedules/delete" Defined in src/lib/seam/connect/route-types.ts:8211 /thermostats/climate_ setting_ schedules/get /thermostats/climate_ setting_ schedules/get : { commonParams : { climate_setting_schedule_id ?: string ; device_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { climate_setting_schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/thermostats/climate_setting_schedules/get" ; }
Type declaration common Params : { climate_setting_schedule_id ?: string ; device_id ?: string ; } Optional
climate_ setting_ schedule_ id ?: string Optional
device_ id ?: string form Data : {} json Body : {} json Response : { climate_setting_schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } ; } climate_ setting_ schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } Optional
automatic_ cooling_ enabled ?: boolean Optional
automatic_ heating_ enabled ?: boolean climate_ setting_ schedule_ id : string Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number created_ at : string device_ id : string Optional
errors ?: any Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
hvac_ mode_ setting ?: "off" | "heat" | "cool" | "heat_cool" Optional
manual_ override_ allowed ?: boolean Optional
name ?: string schedule_ ends_ at : string schedule_ starts_ at : string schedule_ type : "time_bound" method : "GET" | "POST" query Params : {} route : "/thermostats/climate_setting_schedules/get" Defined in src/lib/seam/connect/route-types.ts:8222 /thermostats/climate_ setting_ schedules/list /thermostats/climate_ setting_ schedules/list : { commonParams : { device_id : string ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { climate_setting_schedules : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/thermostats/climate_setting_schedules/list" ; }
Type declaration common Params : { device_id : string ; user_identifier_key ?: string ; } device_ id : string Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { climate_setting_schedules : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } [] ; } climate_ setting_ schedules : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } [] method : "GET" | "POST" query Params : {} route : "/thermostats/climate_setting_schedules/list" Defined in src/lib/seam/connect/route-types.ts:8254 /thermostats/climate_ setting_ schedules/update /thermostats/climate_ setting_ schedules/update : { commonParams : {} ; formData : {} ; jsonBody : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at ?: string ; schedule_starts_at ?: string ; schedule_type ?: "time_bound" ; } ; jsonResponse : { climate_setting_schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } ; } ; method : "POST" | "PUT" | "PATCH" ; queryParams : {} ; route : "/thermostats/climate_setting_schedules/update" ; }
Type declaration common Params : {} form Data : {} json Body : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at ?: string ; schedule_starts_at ?: string ; schedule_type ?: "time_bound" ; } Optional
automatic_ cooling_ enabled ?: boolean Optional
automatic_ heating_ enabled ?: boolean climate_ setting_ schedule_ id : string Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
hvac_ mode_ setting ?: "off" | "heat" | "cool" | "heat_cool" Optional
manual_ override_ allowed ?: boolean Optional
name ?: string Optional
schedule_ ends_ at ?: string Optional
schedule_ starts_ at ?: string Optional
schedule_ type ?: "time_bound" json Response : { climate_setting_schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } ; } climate_ setting_ schedule : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; climate_setting_schedule_id : string ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; created_at : string ; device_id : string ; errors ?: any ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; name ?: string ; schedule_ends_at : string ; schedule_starts_at : string ; schedule_type : "time_bound" ; } Optional
automatic_ cooling_ enabled ?: boolean Optional
automatic_ heating_ enabled ?: boolean climate_ setting_ schedule_ id : string Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number created_ at : string device_ id : string Optional
errors ?: any Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
hvac_ mode_ setting ?: "off" | "heat" | "cool" | "heat_cool" Optional
manual_ override_ allowed ?: boolean Optional
name ?: string schedule_ ends_ at : string schedule_ starts_ at : string schedule_ type : "time_bound" method : "POST" | "PUT" | "PATCH" query Params : {} route : "/thermostats/climate_setting_schedules/update" Defined in src/lib/seam/connect/route-types.ts:8286 /thermostats/cool /thermostats/cool : { commonParams : {} ; formData : {} ; jsonBody : { cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; device_id : string ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/thermostats/cool" ; }
Type declaration common Params : {} form Data : {} json Body : { cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; device_id : string ; sync ?: boolean ; } Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number device_ id : string Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/thermostats/cool" Defined in src/lib/seam/connect/route-types.ts:8329 /thermostats/get /thermostats/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { thermostat : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/thermostats/get" ; }
Type declaration common Params : { device_id ?: string ; name ?: string ; } Optional
device_ id ?: string Optional
name ?: string form Data : {} json Body : {} json Response : { thermostat : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } thermostat : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } Optional
can_ program_ online_ access_ codes ?: boolean Optional
can_ remotely_ lock ?: boolean Optional
can_ remotely_ unlock ?: boolean Optional
can_ simulate_ removal ?: boolean capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] connected_ account_ id : string created_ at : string custom_ metadata : Record < string , string | boolean > device_ id : string device_ type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" display_ name : string errors : { error_code : string ; message : string ; } [] is_ managed : true location : null | { location_name ?: string ; timezone ?: string ; } Optional
nickname ?: string properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : string ; check_out_time : string ; dormakaba_oracode_user_level_id : string ; ext_dormakaba_oracode_user_level_prefix : number ; is_24_hour : boolean ; is_biweekly_mode : boolean ; is_master : boolean ; is_one_shot : boolean ; name : string ; prefix : number ; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) warnings : { message : string ; warning_code : string ; } [] workspace_ id : string method : "GET" | "POST" query Params : {} route : "/thermostats/get" Defined in src/lib/seam/connect/route-types.ts:8369 /thermostats/heat /thermostats/heat : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/thermostats/heat" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; sync ?: boolean ; } device_ id : string Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/thermostats/heat" Defined in src/lib/seam/connect/route-types.ts:9110 /thermostats/heat_ cool /thermostats/heat_ cool : { commonParams : {} ; formData : {} ; jsonBody : { cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; device_id : string ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/thermostats/heat_cool" ; }
Type declaration common Params : {} form Data : {} json Body : { cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; device_id : string ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; sync ?: boolean ; } Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number device_ id : string Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/thermostats/heat_cool" Defined in src/lib/seam/connect/route-types.ts:9150 /thermostats/list /thermostats/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { thermostats : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/thermostats/list" ; }
Type declaration common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: Date ; custom_metadata_has ?: Record < string , string | boolean > ; device_ids ?: string [] ; device_type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; device_types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] ; exclude_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; include_if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] ; limit ?: number ; manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } Optional
connect_ webview_ id ?: string Optional
connected_ account_ id ?: string Optional
connected_ account_ ids ?: string [] Optional
created_ before ?: Date Optional
custom_ metadata_ has ?: Record < string , string | boolean > Optional
device_ ids ?: string [] Optional
device_ type ?: "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" Optional
device_ types ?: ( "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ) [] Optional
exclude_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
include_ if ?: ( "can_remotely_unlock" | "can_remotely_lock" | "can_program_online_access_codes" | "can_simulate_removal" ) [] Optional
limit ?: number Optional
manufacturer ?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n" Optional
user_ identifier_ key ?: string form Data : {} json Body : {} json Response : { thermostats : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } thermostats : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/thermostats/list" Defined in src/lib/seam/connect/route-types.ts:9192 /thermostats/off /thermostats/off : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/thermostats/off" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; sync ?: boolean ; } device_ id : string Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/thermostats/off" Defined in src/lib/seam/connect/route-types.ts:10072 /thermostats/set_ fan_ mode /thermostats/set_ fan_ mode : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; fan_mode ?: "auto" | "on" ; fan_mode_setting ?: "auto" | "on" ; sync ?: boolean ; } ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/thermostats/set_fan_mode" ; }
Type declaration common Params : {} form Data : {} json Body : { device_id : string ; fan_mode ?: "auto" | "on" ; fan_mode_setting ?: "auto" | "on" ; sync ?: boolean ; } device_ id : string Optional
fan_ mode ?: "auto" | "on" Optional
fan_ mode_ setting ?: "auto" | "on" Optional
sync ?: boolean json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/thermostats/set_fan_mode" Defined in src/lib/seam/connect/route-types.ts:10110 /thermostats/update /thermostats/update : { commonParams : {} ; formData : {} ; jsonBody : { default_climate_setting : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; } ; device_id : string ; } ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/thermostats/update" ; }
Type declaration common Params : {} form Data : {} json Body : { default_climate_setting : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; } ; device_id : string ; } default_ climate_ setting : { automatic_cooling_enabled ?: boolean ; automatic_heating_enabled ?: boolean ; cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; hvac_mode_setting ?: "off" | "heat" | "cool" | "heat_cool" ; manual_override_allowed ?: boolean ; } Optional
automatic_ cooling_ enabled ?: boolean Optional
automatic_ heating_ enabled ?: boolean Optional
cooling_ set_ point_ celsius ?: number Optional
cooling_ set_ point_ fahrenheit ?: number Optional
heating_ set_ point_ celsius ?: number Optional
heating_ set_ point_ fahrenheit ?: number Optional
hvac_ mode_ setting ?: "off" | "heat" | "cool" | "heat_cool" Optional
manual_ override_ allowed ?: boolean device_ id : string json Response : {} method : "POST" | "PATCH" query Params : {} route : "/thermostats/update" Defined in src/lib/seam/connect/route-types.ts:10150 /user_ identities/add_ acs_ user /user_ identities/add_ acs_ user : { commonParams : { acs_user_id : string ; user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PUT" ; queryParams : {} ; route : "/user_identities/add_acs_user" ; }
Type declaration common Params : { acs_user_id : string ; user_identity_id : string ; } acs_ user_ id : string user_ identity_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "PUT" query Params : {} route : "/user_identities/add_acs_user" Defined in src/lib/seam/connect/route-types.ts:10171 /user_ identities/create /user_ identities/create : { commonParams : { email_address ?: null | string ; full_name ?: null | string ; phone_number ?: null | string ; user_identity_key ?: null | string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { user_identity : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/user_identities/create" ; }
Type declaration common Params : { email_address ?: null | string ; full_name ?: null | string ; phone_number ?: null | string ; user_identity_key ?: null | string ; } Optional
email_ address ?: null | string Optional
full_ name ?: null | string Optional
phone_ number ?: null | string Optional
user_ identity_ key ?: null | string form Data : {} json Body : {} json Response : { user_identity : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } ; } user_ identity : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } created_ at : string display_ name : string email_ address : null | string full_ name : null | string phone_ number : null | string user_ identity_ id : string user_ identity_ key : null | string workspace_ id : string method : "POST" query Params : {} route : "/user_identities/create" Defined in src/lib/seam/connect/route-types.ts:10183 /user_ identities/delete /user_ identities/delete : { commonParams : { user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/user_identities/delete" ; }
Type declaration common Params : { user_identity_id : string ; } form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/user_identities/delete" Defined in src/lib/seam/connect/route-types.ts:10208 /user_ identities/enrollment_ automations/delete /user_ identities/enrollment_ automations/delete : { commonParams : { enrollment_automation_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/user_identities/enrollment_automations/delete" ; }
Type declaration common Params : { enrollment_automation_id : string ; } enrollment_ automation_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/user_identities/enrollment_automations/delete" Defined in src/lib/seam/connect/route-types.ts:10219 /user_ identities/enrollment_ automations/get /user_ identities/enrollment_ automations/get : { commonParams : { enrollment_automation_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { enrollment_automation : { created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/user_identities/enrollment_automations/get" ; }
Type declaration common Params : { enrollment_automation_id : string ; } enrollment_ automation_ id : string form Data : {} json Body : {} json Response : { enrollment_automation : { created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } ; } enrollment_ automation : { created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } created_ at : string credential_ manager_ acs_ system_ id : string enrollment_ automation_ id : string user_ identity_ id : string workspace_ id : string method : "GET" | "POST" query Params : {} route : "/user_identities/enrollment_automations/get" Defined in src/lib/seam/connect/route-types.ts:10230 /user_ identities/enrollment_ automations/launch /user_ identities/enrollment_ automations/launch : { commonParams : { acs_credential_pool_id ?: string ; create_credential_manager_user ?: boolean ; credential_manager_acs_system_id : string ; credential_manager_acs_user_id ?: string ; user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { enrollment_automation : { acs_credential_provisioning_automation_id : string ; created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/user_identities/enrollment_automations/launch" ; }
Type declaration common Params : { acs_credential_pool_id ?: string ; create_credential_manager_user ?: boolean ; credential_manager_acs_system_id : string ; credential_manager_acs_user_id ?: string ; user_identity_id : string ; } Optional
acs_ credential_ pool_ id ?: string Optional
create_ credential_ manager_ user ?: boolean credential_ manager_ acs_ system_ id : string Optional
credential_ manager_ acs_ user_ id ?: string user_ identity_ id : string form Data : {} json Body : {} json Response : { enrollment_automation : { acs_credential_provisioning_automation_id : string ; created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } ; } enrollment_ automation : { acs_credential_provisioning_automation_id : string ; created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } acs_ credential_ provisioning_ automation_ id : string created_ at : string credential_ manager_ acs_ system_ id : string enrollment_ automation_ id : string user_ identity_ id : string workspace_ id : string method : "POST" query Params : {} route : "/user_identities/enrollment_automations/launch" Defined in src/lib/seam/connect/route-types.ts:10249 /user_ identities/enrollment_ automations/list /user_ identities/enrollment_ automations/list : { commonParams : { user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { enrollment_automations : { created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/user_identities/enrollment_automations/list" ; }
Type declaration common Params : { user_identity_id : string ; } form Data : {} json Body : {} json Response : { enrollment_automations : { created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } [] ; } enrollment_ automations : { created_at : string ; credential_manager_acs_system_id : string ; enrollment_automation_id : string ; user_identity_id : string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/user_identities/enrollment_automations/list" Defined in src/lib/seam/connect/route-types.ts:10273 /user_ identities/get /user_ identities/get : { commonParams : { user_identity_id : string ; } | { user_identity_key : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { user_identity : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/user_identities/get" ; }
Type declaration common Params : { user_identity_id : string ; } | { user_identity_key : string ; } form Data : {} json Body : {} json Response : { user_identity : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } ; } user_ identity : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } created_ at : string display_ name : string email_ address : null | string full_ name : null | string phone_ number : null | string user_ identity_ id : string user_ identity_ key : null | string workspace_ id : string method : "GET" | "POST" query Params : {} route : "/user_identities/get" Defined in src/lib/seam/connect/route-types.ts:10292 /user_ identities/grant_ access_ to_ device /user_ identities/grant_ access_ to_ device : { commonParams : { device_id : string ; user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PUT" ; queryParams : {} ; route : "/user_identities/grant_access_to_device" ; }
Type declaration common Params : { device_id : string ; user_identity_id : string ; } device_ id : string user_ identity_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "PUT" query Params : {} route : "/user_identities/grant_access_to_device" Defined in src/lib/seam/connect/route-types.ts:10318 /user_ identities/list /user_ identities/list : { commonParams : { credential_manager_acs_system_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { user_identities : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/user_identities/list" ; }
Type declaration common Params : { credential_manager_acs_system_id ?: string ; } Optional
credential_ manager_ acs_ system_ id ?: string form Data : {} json Body : {} json Response : { user_identities : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } [] ; } user_ identities : { created_at : string ; display_name : string ; email_address : null | string ; full_name : null | string ; phone_number : null | string ; user_identity_id : string ; user_identity_key : null | string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/user_identities/list" Defined in src/lib/seam/connect/route-types.ts:10330 /user_ identities/list_ accessible_ devices /user_ identities/list_ accessible_ devices : { commonParams : { user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { accessible_devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/user_identities/list_accessible_devices" ; }
Type declaration common Params : { user_identity_id : string ; } form Data : {} json Body : {} json Response : { accessible_devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } accessible_ devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] devices : { can_program_online_access_codes ?: boolean ; can_remotely_lock ?: boolean ; can_remotely_unlock ?: boolean ; can_simulate_removal ?: boolean ; capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone" ) [] ; connected_account_id : string ; created_at : string ; custom_metadata : Record < string , string | boolean > ; device_id : string ; device_type : "akuvox_lock" | "august_lock" | "brivo_access_point" | "butterflymx_panel" | "avigilon_alta_entry" | "doorking_lock" | "genie_door" | "igloo_lock" | "linear_lock" | "lockly_lock" | "kwikset_lock" | "nuki_lock" | "salto_lock" | "schlage_lock" | "seam_relay" | "smartthings_lock" | "wyze_lock" | "yale_lock" | "two_n_intercom" | "controlbyweb_device" | "ttlock_lock" | "igloohome_lock" | "hubitat_lock" | "four_suites_door" | "dormakaba_oracode_door" | "tedee_lock" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" | "honeywell_resideo_thermostat" | "ios_phone" | "android_phone" ; display_name : string ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; nickname ?: string ; properties : { accessory_keypad ?: { battery ?: { level : number ; } ; is_connected : boolean ; } ; appearance : { name : string ; } ; battery ?: { level : number ; status : "low" | "full" | "critical" | "good" ; } ; battery_level ?: number ; has_direct_power ?: boolean ; image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { accessory_keypad_supported ?: boolean ; can_connect_accessory_keypad ?: boolean ; display_name : string ; has_built_in_keypad ?: boolean ; manufacturer_display_name : string ; offline_access_codes_supported ?: boolean ; online_access_codes_supported ?: boolean ; } ; name : string ; offline_access_codes_enabled ?: boolean ; online : boolean ; online_access_codes_enabled ?: boolean ; serial_number ?: string ; supports_accessory_keypad ?: boolean ; supports_offline_access_codes ?: boolean ; } & { assa_abloy_credential_service_metadata ?: { endpoints : { endpoint_id : string ; is_active : boolean ; } [] ; has_active_endpoint : boolean ; } ; } & { august_metadata ?: { has_keypad : boolean ; house_id ?: string ; house_name : string ; keypad_battery_level ?: string ; lock_id : string ; lock_name : string ; model ?: string ; } ; avigilon_alta_metadata ?: { entry_name : string ; org_name : string ; site_id : number ; site_name : string ; zone_id : number ; zone_name : string ; } ; brivo_metadata ?: { device_name : string ; } ; controlbyweb_metadata ?: { device_id : string ; device_name : string ; relay_name : null | string ; } ; dormakaba_oracode_metadata ?: { device_id ?: number ; door_id : number ; door_name : string ; iana_timezone ?: string ; predefined_time_slots ?: { check_in_time : ...; check_out_time : ...; dormakaba_oracode_user_level_id : ...; ext_dormakaba_oracode_user_level_prefix : ...; is_24_hour : ...; is_biweekly_mode : ...; is_master : ...; is_one_shot : ...; name : ...; prefix : ...; } [] ; site_id : number ; site_name : string ; } ; ecobee_metadata ?: { device_name : string ; ecobee_device_id : string ; } ; four_suites_metadata ?: { device_id : number ; device_name : string ; reclose_delay_in_seconds : number ; } ; genie_metadata ?: { device_name : string ; door_name : string ; } ; honeywell_resideo_metadata ?: { device_name : string ; honeywell_resideo_device_id : string ; } ; hubitat_metadata ?: { device_id : string ; device_label : string ; device_name : string ; } ; igloo_metadata ?: { bridge_id : string ; device_id : string ; model ?: string ; } ; igloohome_metadata ?: { bridge_id ?: string ; bridge_name ?: string ; device_id : string ; device_name : string ; keypad_id ?: string ; } ; kwikset_metadata ?: { device_id : string ; device_name : string ; model_number : string ; } ; lockly_metadata ?: { device_id : string ; device_name : string ; model ?: string ; } ; minut_metadata ?: { device_id : string ; device_name : string ; latest_sensor_values : { accelerometer_z : { time : string ; value : number ; } ; humidity : { time : string ; value : number ; } ; pressure : { time : string ; value : number ; } ; sound : { time : string ; value : number ; } ; temperature : { time : string ; value : number ; } ; } ; } ; nest_metadata ?: { custom_name : string ; device_name : string ; nest_device_id : string ; } ; noiseaware_metadata ?: { device_id : string ; device_model : "indoor" | "outdoor" ; device_name : string ; noise_level_decibel : number ; noise_level_nrs : number ; } ; nuki_metadata ?: { device_id : string ; device_name : string ; keypad_2_paired ?: boolean ; keypad_battery_critical ?: boolean ; keypad_paired ?: boolean ; } ; salto_metadata ?: { battery_level : string ; customer_reference : string ; lock_id : string ; lock_type : string ; locked_state : string ; model ?: string ; } ; schlage_metadata ?: { access_code_length : null | number ; device_id : string ; device_name : string ; model ?: string ; } ; seam_bridge_metadata ?: { device_num : number ; name : string ; unlock_method ?: "bridge" | "doorking" ; } ; smartthings_metadata ?: { device_id : string ; device_name : string ; location_id ?: string ; model ?: string ; } ; tedee_metadata ?: { bridge_id : number ; bridge_name : string ; device_id : number ; device_model : string ; device_name : string ; keypad_id ?: number ; serial_number : string ; } ; ttlock_metadata ?: { lock_alias : string ; lock_id : number ; } ; two_n_metadata ?: { device_id : number ; device_name : string ; } ; wyze_metadata ?: { device_id : string ; device_info_model : string ; device_name : string ; keypad_uuid ?: string ; locker_status_hardlock ?: number ; product_model : string ; product_name : string ; product_type : string ; } ; } & ( { _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 4 more ... | "at_least_three_unique_digits"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; }...) ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/user_identities/list_accessible_devices" Defined in src/lib/seam/connect/route-types.ts:10352 /user_ identities/list_ acs_ systems /user_ identities/list_ acs_ systems : { commonParams : { user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_systems : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/user_identities/list_acs_systems" ; }
Type declaration common Params : { user_identity_id : string ; } form Data : {} json Body : {} json Response : { acs_systems : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } [] ; } acs_ systems : { acs_system_id : string ; can_automate_enrollment ?: boolean ; connected_account_ids : string [] ; created_at : string ; external_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; external_type_display_name ?: string ; image_alt_text : string ; image_url : string ; name : string ; system_type ?: "pti_site" | "alta_org" | "salto_site" | "brivo_account" | "hid_credential_manager_organization" | "visionline_system" | "assa_abloy_credential_service" | "latch_building" ; system_type_display_name ?: string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/user_identities/list_acs_systems" Defined in src/lib/seam/connect/route-types.ts:11825 /user_ identities/list_ acs_ users /user_ identities/list_ acs_ users : { commonParams : { user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/user_identities/list_acs_users" ; }
Type declaration common Params : { user_identity_id : string ; } form Data : {} json Body : {} json Response : { acs_users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] ; } acs_ users : { access_schedule ?: { ends_at : string ; starts_at : string ; } ; acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; email_address ?: string ; external_type ?: "pti_user" | "brivo_user" | "hid_credential_manager_user" | "salto_site_user" | "latch_user" ; external_type_display_name ?: string ; full_name ?: string ; hid_acs_system_id ?: string ; is_suspended : boolean ; phone_number ?: string ; user_identity_email_address ?: null | string ; user_identity_full_name ?: null | string ; user_identity_id ?: string ; user_identity_phone_number ?: null | string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/user_identities/list_acs_users" Defined in src/lib/seam/connect/route-types.ts:11883 /user_ identities/remove_ acs_ user /user_ identities/remove_ acs_ user : { commonParams : { acs_user_id : string ; user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/user_identities/remove_acs_user" ; }
Type declaration common Params : { acs_user_id : string ; user_identity_id : string ; } acs_ user_ id : string user_ identity_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/user_identities/remove_acs_user" Defined in src/lib/seam/connect/route-types.ts:11933 /user_ identities/revoke_ access_ to_ device /user_ identities/revoke_ access_ to_ device : { commonParams : { device_id : string ; user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/user_identities/revoke_access_to_device" ; }
Type declaration common Params : { device_id : string ; user_identity_id : string ; } device_ id : string user_ identity_ id : string form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/user_identities/revoke_access_to_device" Defined in src/lib/seam/connect/route-types.ts:11945 /user_ identities/update /user_ identities/update : { commonParams : {} ; formData : {} ; jsonBody : { email_address ?: null | string ; full_name ?: null | string ; phone_number ?: null | string ; user_identity_id : string ; user_identity_key ?: null | string ; } ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/user_identities/update" ; }
Type declaration common Params : {} form Data : {} json Body : { email_address ?: null | string ; full_name ?: null | string ; phone_number ?: null | string ; user_identity_id : string ; user_identity_key ?: null | string ; } Optional
email_ address ?: null | string Optional
full_ name ?: null | string Optional
phone_ number ?: null | string user_ identity_ id : string Optional
user_ identity_ key ?: null | string json Response : {} method : "POST" | "PATCH" query Params : {} route : "/user_identities/update" Defined in src/lib/seam/connect/route-types.ts:11957 /webhooks/create /webhooks/create : { commonParams : {} ; formData : {} ; jsonBody : { event_types ?: string [] ; url : string ; } ; jsonResponse : { webhook : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/webhooks/create" ; }
Type declaration common Params : {} form Data : {} json Body : { event_types ?: string [] ; url : string ; } Optional
event_ types ?: string [] url : string json Response : { webhook : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } ; } webhook : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } Optional
event_ types ?: string [] Optional
secret ?: string url : string webhook_ id : string method : "POST" query Params : {} route : "/webhooks/create" Defined in src/lib/seam/connect/route-types.ts:11972 /webhooks/delete /webhooks/delete : { commonParams : { webhook_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/webhooks/delete" ; }
Type declaration common Params : { webhook_id : string ; } form Data : {} json Body : {} json Response : {} method : "POST" | "DELETE" query Params : {} route : "/webhooks/delete" Defined in src/lib/seam/connect/route-types.ts:11991 /webhooks/get /webhooks/get : { commonParams : { webhook_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { webhook : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/webhooks/get" ; }
Type declaration common Params : { webhook_id : string ; } form Data : {} json Body : {} json Response : { webhook : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } ; } webhook : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } Optional
event_ types ?: string [] Optional
secret ?: string url : string webhook_ id : string method : "GET" | "POST" query Params : {} route : "/webhooks/get" Defined in src/lib/seam/connect/route-types.ts:12002 /webhooks/list /webhooks/list : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { webhooks : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/webhooks/list" ; }
Type declaration common Params : {} form Data : {} json Body : {} json Response : { webhooks : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } [] ; } webhooks : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/webhooks/list" Defined in src/lib/seam/connect/route-types.ts:12020 /webhooks/update /webhooks/update : { commonParams : {} ; formData : {} ; jsonBody : { event_types : string [] ; webhook_id : string ; } ; jsonResponse : {} ; method : "POST" | "PUT" ; queryParams : {} ; route : "/webhooks/update" ; }
Type declaration common Params : {} form Data : {} json Body : { event_types : string [] ; webhook_id : string ; } event_ types : string [] webhook_ id : string json Response : {} method : "POST" | "PUT" query Params : {} route : "/webhooks/update" Defined in src/lib/seam/connect/route-types.ts:12036 /workspaces/create /workspaces/create : { commonParams : {} ; formData : {} ; jsonBody : { connect_partner_name : string ; is_sandbox ?: boolean ; name : string ; webview_logo_shape ?: "square" | "circle" ; webview_primary_button_color ?: string ; } ; jsonResponse : { workspace : { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/workspaces/create" ; }
Type declaration common Params : {} form Data : {} json Body : { connect_partner_name : string ; is_sandbox ?: boolean ; name : string ; webview_logo_shape ?: "square" | "circle" ; webview_primary_button_color ?: string ; } connect_ partner_ name : string Optional
is_ sandbox ?: boolean name : string Optional
webview_ logo_ shape ?: "square" | "circle" Optional
webview_ primary_ button_ color ?: string json Response : { workspace : { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } ; } workspace : { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } connect_ partner_ name : null | string is_ sandbox : boolean name : string workspace_ id : string method : "POST" query Params : {} route : "/workspaces/create" Defined in src/lib/seam/connect/route-types.ts:12048 /workspaces/get /workspaces/get : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { workspace ?: { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/workspaces/get" ; }
Type declaration common Params : {} form Data : {} json Body : {} json Response : { workspace ?: { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } ; } Optional
workspace ?: { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } connect_ partner_ name : null | string is_ sandbox : boolean name : string workspace_ id : string method : "GET" | "POST" query Params : {} route : "/workspaces/get" Defined in src/lib/seam/connect/route-types.ts:12071 /workspaces/list /workspaces/list : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { workspaces : { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } [] ; } ; method : "GET" | "POST" ; queryParams : {} ; route : "/workspaces/list" ; }
Type declaration common Params : {} form Data : {} json Body : {} json Response : { workspaces : { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } [] ; } workspaces : { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } [] method : "GET" | "POST" query Params : {} route : "/workspaces/list" Defined in src/lib/seam/connect/route-types.ts:12089 /workspaces/reset_ sandbox /workspaces/reset_ sandbox : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } ; method : "POST" ; queryParams : {} ; route : "/workspaces/reset_sandbox" ; }
Type declaration common Params : {} form Data : {} json Body : {} json Response : { action_attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } ; } action_ attempt : { action_attempt_id : string ; action_type : string ; error : null ; result ?: any ; status : "success" ; } | { action_attempt_id : string ; action_type : string ; error : null ; result : null ; status : "pending" ; } | { action_attempt_id : string ; action_type : string ; error : { message : string ; type : string ; } ; result : null ; status : "error" ; } method : "POST" query Params : {} route : "/workspaces/reset_sandbox" Defined in src/lib/seam/connect/route-types.ts:12105
Unique identifier for the access code.