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_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_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_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
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 ; 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_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 ; 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
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_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_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:75
/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:122
/access_ codes/generate_ code
/access_ codes/generate_ code : { commonParams : { device_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { generated_code : { code : string ; device_id : string ; } ; } ; method : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/access_codes/generate_code"
Defined in src/lib/seam/connect/route-types.ts:161
/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_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" | "GET" ; 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_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_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
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" | "GET"
query Params : {}
route : "/access_codes/get"
Defined in src/lib/seam/connect/route-types.ts:177
/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_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" | "GET" ; 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_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_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" | "GET"
query Params : {}
route : "/access_codes/list"
Defined in src/lib/seam/connect/route-types.ts:212
/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_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_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_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
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:247
/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:280
/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:308
/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:323
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/access_codes/unmanaged/get"
Defined in src/lib/seam/connect/route-types.ts:361
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/access_codes/unmanaged/list"
Defined in src/lib/seam/connect/route-types.ts:389
/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:416
/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:431
/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:485
/acs/access_ groups/create
/acs/access_ groups/create : { commonParams : { acs_system_id : string ; name ?: 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 : "POST" ; queryParams : {} ; route : "/acs/access_groups/create" ; }
Type declaration
common Params : { acs_system_id : string ; name ?: string ; }
acs_ system_ id : string
Optional
name ?: 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 : "POST"
query Params : {}
route : "/acs/access_groups/create"
Defined in src/lib/seam/connect/route-types.ts:497
/acs/access_ groups/delete
/acs/access_ groups/delete : { commonParams : { acs_access_group_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "DELETE" ; queryParams : {} ; route : "/acs/access_groups/delete" ; }
Type declaration
common Params : { acs_access_group_id : string ; }
acs_ access_ group_ id : string
form Data : {}
json Body : {}
json Response : {}
method : "POST" | "DELETE"
query Params : {}
route : "/acs/access_groups/delete"
Defined in src/lib/seam/connect/route-types.ts:531
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/acs/access_groups/get"
Defined in src/lib/seam/connect/route-types.ts:542
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/acs/access_groups/list"
Defined in src/lib/seam/connect/route-types.ts:575
/acs/access_ groups/list_ users
/acs/access_ groups/list_ users : { commonParams : { acs_access_group_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; 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 : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } [] ; }
acs_ users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/acs/access_groups/list_users"
Defined in src/lib/seam/connect/route-types.ts:609
/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:634
/acs/access_ groups/update
/acs/access_ groups/update : { commonParams : { acs_access_group_id : string ; name ?: null | string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/acs/access_groups/update" ; }
Type declaration
common Params : { acs_access_group_id : string ; name ?: null | string ; }
acs_ access_ group_ id : string
Optional
name ?: null | string
form Data : {}
json Body : {}
json Response : {}
method : "POST" | "PATCH"
query Params : {}
route : "/acs/access_groups/update"
Defined in src/lib/seam/connect/route-types.ts:646
/acs/credentials/create
/acs/credentials/create : { commonParams : { acs_user_id : string ; code : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credential : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/acs/credentials/create" ; }
Type declaration
common Params : { acs_user_id : string ; code : string ; }
acs_ user_ id : string
code : string
form Data : {}
json Body : {}
json Response : { acs_credential : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; } ; }
acs_ credential : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; }
acs_ credential_ id : string
acs_ system_ id : string
acs_ user_ id : string
code : null | string
created_ at : string
external_ type : "pti_card"
external_ type_ display_ name : string
workspace_ id : string
method : "POST"
query Params : {}
route : "/acs/credentials/create"
Defined in src/lib/seam/connect/route-types.ts:658
/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:681
/acs/credentials/get
/acs/credentials/get : { commonParams : { acs_credentials_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credential : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/acs/credentials/get" ; }
Type declaration
common Params : { acs_credentials_id : string ; }
acs_ credentials_ id : string
form Data : {}
json Body : {}
json Response : { acs_credential : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; } ; }
acs_ credential : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; }
acs_ credential_ id : string
acs_ system_ id : string
acs_ user_ id : string
code : null | string
created_ at : string
external_ type : "pti_card"
external_ type_ display_ name : string
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/acs/credentials/get"
Defined in src/lib/seam/connect/route-types.ts:692
/acs/credentials/list
/acs/credentials/list : { commonParams : { acs_user_id : string ; } | { acs_system_id : string ; } | { acs_system_id : string ; acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_credentials : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; 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 ; }
form Data : {}
json Body : {}
json Response : { acs_credentials : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; } [] ; }
acs_ credentials : { acs_credential_id : string ; acs_system_id : string ; acs_user_id : string ; code : null | string ; created_at : string ; external_type : "pti_card" ; external_type_display_name : string ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/acs/credentials/list"
Defined in src/lib/seam/connect/route-types.ts:714
/acs/systems/get
/acs/systems/get : { commonParams : { acs_system_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_system : { acs_system_id : string ; connected_account_ids : string [] ; created_at : string ; external_type : "pti_site" | "alta_org" | "brivo_system" ; external_type_display_name : string ; name : string ; system_type : "pti_site" | "alta_org" | "brivo_system" ; system_type_display_name : string ; } ; } ; method : "POST" | "GET" ; 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 ; connected_account_ids : string [] ; created_at : string ; external_type : "pti_site" | "alta_org" | "brivo_system" ; external_type_display_name : string ; name : string ; system_type : "pti_site" | "alta_org" | "brivo_system" ; system_type_display_name : string ; } ; }
acs_ system : { acs_system_id : string ; connected_account_ids : string [] ; created_at : string ; external_type : "pti_site" | "alta_org" | "brivo_system" ; external_type_display_name : string ; name : string ; system_type : "pti_site" | "alta_org" | "brivo_system" ; system_type_display_name : string ; }
acs_ system_ id : string
connected_ account_ ids : string []
created_ at : string
external_ type : "pti_site" | "alta_org" | "brivo_system"
external_ type_ display_ name : string
name : string
system_ type : "pti_site" | "alta_org" | "brivo_system"
system_ type_ display_ name : string
method : "POST" | "GET"
query Params : {}
route : "/acs/systems/get"
Defined in src/lib/seam/connect/route-types.ts:744
/acs/systems/list
/acs/systems/list : { commonParams : { connected_account_id ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_systems : { acs_system_id : string ; connected_account_ids : string [] ; created_at : string ; external_type : "pti_site" | "alta_org" | "brivo_system" ; external_type_display_name : string ; name : string ; system_type : "pti_site" | "alta_org" | "brivo_system" ; system_type_display_name : string ; } [] ; } ; method : "POST" | "GET" ; 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 ; connected_account_ids : string [] ; created_at : string ; external_type : "pti_site" | "alta_org" | "brivo_system" ; external_type_display_name : string ; name : string ; system_type : "pti_site" | "alta_org" | "brivo_system" ; system_type_display_name : string ; } [] ; }
acs_ systems : { acs_system_id : string ; connected_account_ids : string [] ; created_at : string ; external_type : "pti_site" | "alta_org" | "brivo_system" ; external_type_display_name : string ; name : string ; system_type : "pti_site" | "alta_org" | "brivo_system" ; system_type_display_name : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/acs/systems/list"
Defined in src/lib/seam/connect/route-types.ts:768
/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:792
/acs/users/create
/acs/users/create : { commonParams : { acs_access_group_ids ?: string [] ; acs_system_id : string ; email ?: string ; full_name ?: string ; phone_number ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_user : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/acs/users/create" ; }
Type declaration
common Params : { acs_access_group_ids ?: string [] ; acs_system_id : string ; email ?: string ; full_name ?: string ; phone_number ?: string ; }
Optional
acs_ access_ group_ ids ?: string []
acs_ system_ id : string
Optional
email ?: string
Optional
full_ name ?: string
Optional
phone_ number ?: string
form Data : {}
json Body : {}
json Response : { acs_user : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } ; }
acs_ user : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; }
acs_ system_ id : string
acs_ user_ id : string
created_ at : string
display_ name : string
Optional
email ?: string
external_ type : "pti_user"
external_ type_ display_ name : string
Optional
full_ name ?: string
is_ suspended : boolean
Optional
phone_ number ?: string
workspace_ id : string
method : "POST"
query Params : {}
route : "/acs/users/create"
Defined in src/lib/seam/connect/route-types.ts:804
/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:833
/acs/users/get
/acs/users/get : { commonParams : { acs_user_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_user : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/acs/users/get" ; }
Type declaration
common Params : { acs_user_id : string ; }
form Data : {}
json Body : {}
json Response : { acs_user : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } ; }
acs_ user : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; }
acs_ system_ id : string
acs_ user_ id : string
created_ at : string
display_ name : string
Optional
email ?: string
external_ type : "pti_user"
external_ type_ display_ name : string
Optional
full_ name ?: string
is_ suspended : boolean
Optional
phone_ number ?: string
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/acs/users/get"
Defined in src/lib/seam/connect/route-types.ts:844
/acs/users/list
/acs/users/list : { commonParams : { acs_system_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/acs/users/list" ; }
Type declaration
common Params : { acs_system_id : string ; }
form Data : {}
json Body : {}
json Response : { acs_users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } [] ; }
acs_ users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/acs/users/list"
Defined in src/lib/seam/connect/route-types.ts:869
/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:894
/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:906
/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:917
/acs/users/update
/acs/users/update : { commonParams : { acs_user_id : string ; email ?: string ; full_name ?: string ; phone_number ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/acs/users/update" ; }
Type declaration
common Params : { acs_user_id : string ; email ?: string ; full_name ?: string ; phone_number ?: string ; }
acs_ user_ id : string
Optional
email ?: string
Optional
full_ name ?: string
Optional
phone_ number ?: string
form Data : {}
json Body : {}
json Response : {}
method : "POST" | "PATCH"
query Params : {}
route : "/acs/users/update"
Defined in src/lib/seam/connect/route-types.ts:928
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/action_attempts/get"
Defined in src/lib/seam/connect/route-types.ts:942
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/action_attempts/list"
Defined in src/lib/seam/connect/route-types.ts:979
/client_ sessions/create
/client_ sessions/create : { commonParams : {} ; formData : {} ; jsonBody : { connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; user_identifier_key ?: string ; } ; jsonResponse : { client_session : { client_session_id : string ; created_at : string ; token : string ; user_identifier_key : null | 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 [] ; user_identifier_key ?: string ; }
Optional
connect_ webview_ ids ?: string []
Optional
connected_ account_ ids ?: string []
Optional
user_ identifier_ key ?: string
json Response : { client_session : { client_session_id : string ; created_at : string ; token : string ; user_identifier_key : null | string ; workspace_id : string ; } ; }
client_ session : { client_session_id : string ; created_at : string ; token : string ; user_identifier_key : null | string ; workspace_id : string ; }
client_ session_ id : string
created_ at : string
token : string
user_ identifier_ key : null | string
workspace_ id : string
method : "POST" | "PUT"
query Params : {}
route : "/client_sessions/create"
Defined in src/lib/seam/connect/route-types.ts:1017
/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:1038
/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 ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; 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 ; 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 ; 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
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/client_sessions/get"
Defined in src/lib/seam/connect/route-types.ts:1049
/client_ sessions/get_ or_ create
/client_ sessions/get_ or_ create : { commonParams : {} ; formData : {} ; jsonBody : { connect_webview_ids ?: string [] ; connected_account_ids ?: string [] ; user_identifier_key ?: string ; } ; jsonResponse : { client_session : { client_session_id : string ; created_at : string ; token : string ; user_identifier_key : null | 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 [] ; user_identifier_key ?: string ; }
Optional
connect_ webview_ ids ?: string []
Optional
connected_ account_ ids ?: string []
Optional
user_ identifier_ key ?: string
json Response : { client_session : { client_session_id : string ; created_at : string ; token : string ; user_identifier_key : null | string ; workspace_id : string ; } ; }
client_ session : { client_session_id : string ; created_at : string ; token : string ; user_identifier_key : null | string ; workspace_id : string ; }
client_ session_ id : string
created_ at : string
token : string
user_ identifier_ key : null | string
workspace_ id : string
method : "POST" | "PUT"
query Params : {}
route : "/client_sessions/get_or_create"
Defined in src/lib/seam/connect/route-types.ts:1072
/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 ; } ; 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 ; 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 ; }
Optional
client_ session_ id ?: string
Optional
connect_ webview_ ids ?: string []
Optional
connected_ account_ ids ?: 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 ; 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 ; 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
workspace_ id : string
method : "POST" | "PATCH"
query Params : {}
route : "/client_sessions/grant_access"
Defined in src/lib/seam/connect/route-types.ts:1093
/client_ sessions/list
/client_ sessions/list : { commonParams : { client_session_id ?: string ; connect_webview_id ?: string ; user_identifier_key ?: 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 ; user_identifier_key : null | string ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/client_sessions/list" ; }
Type declaration
common Params : { client_session_id ?: string ; connect_webview_id ?: string ; user_identifier_key ?: string ; without_user_identifier_key ?: boolean ; }
Optional
client_ session_ id ?: string
Optional
connect_ webview_ id ?: string
Optional
user_ identifier_ key ?: 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 ; user_identifier_key : null | string ; workspace_id : string ; } [] ; }
client_ sessions : { client_session_id : string ; connect_webview_ids : string [] ; connected_account_ids : string [] ; created_at : string ; device_count : number ; user_identifier_key : null | string ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/client_sessions/list"
Defined in src/lib/seam/connect/route-types.ts:1118
/connect_ webviews/create
/connect_ webviews/create : { commonParams : {} ; formData : {} ; jsonBody : { accepted_providers ?: ( "linear" | "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" | "yale_access" ) [] ; automatically_manage_new_devices ?: boolean ; custom_metadata ?: Record < string , null | string | number | boolean > ; custom_redirect_failure_url ?: string ; custom_redirect_url ?: string ; device_selection_mode ?: "none" | "multiple" | "single" ; provider_category ?: "stable" | "consumer_smartlocks" | "internal_beta" ; wait_for_device_creation ?: boolean ; } ; jsonResponse : { connect_webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; } ; } ; method : "POST" ; queryParams : {} ; route : "/connect_webviews/create" ; }
Type declaration
common Params : {}
form Data : {}
json Body : { accepted_providers ?: ( "linear" | "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" | "yale_access" ) [] ; automatically_manage_new_devices ?: boolean ; custom_metadata ?: Record < string , null | string | number | boolean > ; custom_redirect_failure_url ?: string ; custom_redirect_url ?: string ; device_selection_mode ?: "none" | "multiple" | "single" ; provider_category ?: "stable" | "consumer_smartlocks" | "internal_beta" ; wait_for_device_creation ?: boolean ; }
Optional
accepted_ providers ?: ( "linear" | "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" | "yale_access" ) []
Optional
automatically_ manage_ new_ devices ?: boolean
Optional
custom_ metadata ?: Record < string , null | string | number | 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" | "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 ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; } ; }
connect_ webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; }
accepted_ devices : string []
accepted_ providers : string []
any_ device_ allowed : boolean
any_ provider_ allowed : boolean
connect_ webview_ id : string
Optional
connected_ account_ id ?: string
created_ at : string
device_ selection_ mode : "none" | "multiple" | "single"
login_ successful : boolean
status : "failed" | "pending" | "authorized"
url : string
workspace_ id : string
method : "POST"
query Params : {}
route : "/connect_webviews/create"
Defined in src/lib/seam/connect/route-types.ts:1142
/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:1213
/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 ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; 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 ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; } ; }
connect_ webview : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; }
accepted_ devices : string []
accepted_ providers : string []
any_ device_ allowed : boolean
any_ provider_ allowed : boolean
connect_ webview_ id : string
Optional
connected_ account_ id ?: string
created_ at : string
device_ selection_ mode : "none" | "multiple" | "single"
login_ successful : boolean
status : "failed" | "pending" | "authorized"
url : string
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/connect_webviews/get"
Defined in src/lib/seam/connect/route-types.ts:1224
/connect_ webviews/list
/connect_ webviews/list : { commonParams : { user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { connect_webviews : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/connect_webviews/list" ; }
Type declaration
common Params : { user_identifier_key ?: string ; }
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 ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; } [] ; }
connect_ webviews : { accepted_devices : string [] ; accepted_providers : string [] ; any_device_allowed : boolean ; any_provider_allowed : boolean ; connect_webview_id : string ; connected_account_id ?: string ; created_at : string ; device_selection_mode : "none" | "multiple" | "single" ; login_successful : boolean ; status : "failed" | "pending" | "authorized" ; url : string ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/connect_webviews/list"
Defined in src/lib/seam/connect/route-types.ts:1250
/connect_ webviews/view
/connect_ webviews/view : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "GET" ; queryParams : { auth_token : string ; connect_webview_id : string ; } ; route : "/connect_webviews/view" ; }
Type declaration
common Params : {}
form Data : {}
json Body : {}
json Response : {}
method : "GET"
query Params : { auth_token : string ; connect_webview_id : string ; }
auth_ token : string
connect_ webview_ id : string
route : "/connect_webviews/view"
Defined in src/lib/seam/connect/route-types.ts:1276
/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:1288
/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 ; connected_account_id ?: string ; created_at ?: string ; custom_metadata ?: Record < string , null | string | number | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } ; } ; method : "POST" | "GET" ; 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 ; connected_account_id ?: string ; created_at ?: string ; custom_metadata ?: Record < string , null | string | number | 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 ; connected_account_id ?: string ; created_at ?: string ; custom_metadata ?: Record < string , null | string | number | 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
Optional
connected_ account_ id ?: string
Optional
created_ at ?: string
Optional
custom_ metadata ?: Record < string , null | string | number | 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" | "GET"
query Params : {}
route : "/connected_accounts/get"
Defined in src/lib/seam/connect/route-types.ts:1300
/connected_ accounts/list
/connected_ accounts/list : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { connected_accounts : { account_type ?: string ; account_type_display_name : string ; connected_account_id ?: string ; created_at ?: string ; custom_metadata ?: Record < string , null | string | number | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/connected_accounts/list" ; }
Type declaration
common Params : {}
form Data : {}
json Body : {}
json Response : { connected_accounts : { account_type ?: string ; account_type_display_name : string ; connected_account_id ?: string ; created_at ?: string ; custom_metadata ?: Record < string , null | string | number | 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 ; connected_account_id ?: string ; created_at ?: string ; custom_metadata ?: Record < string , null | string | number | boolean > ; errors ?: any ; user_identifier ?: { api_url ?: string ; email ?: string ; exclusive ?: boolean ; phone ?: string ; username ?: string ; } ; warnings ?: any ; } []
method : "POST" | "GET"
query Params : {}
route : "/connected_accounts/list"
Defined in src/lib/seam/connect/route-types.ts:1336
/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:1366
/devices/get
/devices/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; 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 : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; }
device : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; }
capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) []
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
errors : { error_code : string ; message : string ; } []
is_ managed : true
location : null | { location_name ?: string ; timezone ?: string ; }
properties : Object
warnings : { message : string ; warning_code : string ; } []
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/devices/get"
Defined in src/lib/seam/connect/route-types.ts:1377
/devices/list
/devices/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/devices/list" ; }
Type declaration
common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "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 ?: string
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) []
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" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
Optional
user_ identifier_ key ?: string
form Data : {}
json Body : {}
json Response : { devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; }
devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/devices/list"
Defined in src/lib/seam/connect/route-types.ts:1967
/devices/list_ device_ providers
/devices/list_ device_ providers : { commonParams : { provider_category ?: "stable" | "consumer_smartlocks" ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device_providers : { device_provider_name : string ; display_name : string ; image_url : string ; provider_categories : ( "stable" | "consumer_smartlocks" ) [] ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/devices/list_device_providers" ; }
Type declaration
common Params : { provider_category ?: "stable" | "consumer_smartlocks" ; }
Optional
provider_ category ?: "stable" | "consumer_smartlocks"
form Data : {}
json Body : {}
json Response : { device_providers : { device_provider_name : string ; display_name : string ; image_url : string ; provider_categories : ( "stable" | "consumer_smartlocks" ) [] ; } [] ; }
device_ providers : { device_provider_name : string ; display_name : string ; image_url : string ; provider_categories : ( "stable" | "consumer_smartlocks" ) [] ; } []
method : "POST" | "GET"
query Params : {}
route : "/devices/list_device_providers"
Defined in src/lib/seam/connect/route-types.ts:2665
/devices/unmanaged/get
/devices/unmanaged/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { display_name : string ; manufacturer_display_name : string ; } ; name : string ; online : boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; 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 : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { display_name : string ; manufacturer_display_name : string ; } ; name : string ; online : boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; }
device : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { display_name : string ; manufacturer_display_name : string ; } ; name : string ; online : boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; }
capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) []
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
errors : { error_code : string ; message : string ; } []
is_ managed : false
properties : { image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { display_name : string ; manufacturer_display_name : string ; } ; name : string ; online : boolean ; }
Optional
image_ alt_ text ?: string
Optional
image_ url ?: string
Optional
manufacturer ?: string
model : { display_name : string ; manufacturer_display_name : string ; }
display_ name : string
manufacturer_ display_ name : string
name : string
online : boolean
warnings : { message : string ; warning_code : string ; } []
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/devices/unmanaged/get"
Defined in src/lib/seam/connect/route-types.ts:2683
/devices/unmanaged/list
/devices/unmanaged/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { display_name : string ; manufacturer_display_name : string ; } ; name : string ; online : boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/devices/unmanaged/list" ; }
Type declaration
common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "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 ?: string
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) []
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" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
Optional
user_ identifier_ key ?: string
form Data : {}
json Body : {}
json Response : { devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { display_name : string ; manufacturer_display_name : string ; } ; name : string ; online : boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; }
devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : false ; properties : { image_alt_text ?: string ; image_url ?: string ; manufacturer ?: string ; model : { display_name : string ; manufacturer_display_name : string ; } ; name : string ; online : boolean ; } ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/devices/unmanaged/list"
Defined in src/lib/seam/connect/route-types.ts:2755
/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:2935
/devices/update
/devices/update : { commonParams : { device_id : string ; is_managed ?: boolean ; location ?: {} ; name ?: null | string ; properties ?: { name ?: null | string ; } ; } ; formData : {} ; jsonBody : {} ; jsonResponse : {} ; method : "POST" | "PATCH" ; queryParams : {} ; route : "/devices/update" ; }
Type declaration
common Params : { device_id : string ; is_managed ?: boolean ; location ?: {} ; name ?: null | string ; properties ?: { name ?: null | string ; } ; }
device_ id : string
Optional
is_ managed ?: boolean
Optional
location ?: {}
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:2947
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/events/get"
Defined in src/lib/seam/connect/route-types.ts:2966
/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.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" | "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" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" ; event_types ?: ( "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "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" | "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" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" ) [] ; since ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { events ?: { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } [] ; message ?: string ; } ; method : "POST" | "GET" ; 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.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" | "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" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" ; event_types ?: ( "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "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" | "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" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" ) [] ; 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.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" | "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" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled"
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.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" | "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" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled" ) []
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 ; } [] ; message ?: string ; }
Optional
events ?: { created_at : string ; device_id ?: string ; event_id : string ; event_type : string ; occurred_at : string ; workspace_id : string ; } []
Optional
message ?: string
method : "POST" | "GET"
query Params : {}
route : "/events/list"
Defined in src/lib/seam/connect/route-types.ts:2991
/health
/health : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { last_service_evaluation_at ?: string ; msg : "I’m one with the Force. The Force is with me." ; ok : boolean ; service_health_statuses : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } [] ; } ; method : "GET" ; queryParams : {} ; route : "/health" ; }
Type declaration
common Params : {}
form Data : {}
json Body : {}
json Response : { last_service_evaluation_at ?: string ; msg : "I’m one with the Force. The Force is with me." ; ok : boolean ; service_health_statuses : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } [] ; }
Optional
last_ service_ evaluation_ at ?: string
msg : "I’m one with the Force. The Force is with me."
ok : boolean
service_ health_ statuses : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } []
method : "GET"
query Params : {}
route : "/health"
Defined in src/lib/seam/connect/route-types.ts:3112
/health/get_ health
/health/get_ health : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { last_service_evaluation_at ?: string ; msg : "I’m one with the Force. The Force is with me." ; ok : boolean ; service_health_statuses : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } [] ; } ; method : "GET" ; queryParams : {} ; route : "/health/get_health" ; }
Type declaration
common Params : {}
form Data : {}
json Body : {}
json Response : { last_service_evaluation_at ?: string ; msg : "I’m one with the Force. The Force is with me." ; ok : boolean ; service_health_statuses : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } [] ; }
Optional
last_ service_ evaluation_ at ?: string
msg : "I’m one with the Force. The Force is with me."
ok : boolean
service_ health_ statuses : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } []
method : "GET"
query Params : {}
route : "/health/get_health"
Defined in src/lib/seam/connect/route-types.ts:3130
/health/get_ service_ health
/health/get_ service_ health : { commonParams : { service : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { last_service_evaluation_at : string ; ok : true ; service_health : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/health/get_service_health" ; }
Type declaration
common Params : { service : string ; }
form Data : {}
json Body : {}
json Response : { last_service_evaluation_at : string ; ok : true ; service_health : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } ; }
last_ service_ evaluation_ at : string
ok : true
service_ health : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; }
description : string
service : string
status : "healthy" | "degraded" | "down"
method : "POST" | "GET"
query Params : {}
route : "/health/get_service_health"
Defined in src/lib/seam/connect/route-types.ts:3148
/health/service/[service_ name]
/health/service/[service_ name] : { commonParams : { service_name : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { last_service_evaluation_at : string ; ok : true ; service_health : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/health/service/[service_name]" ; }
Type declaration
common Params : { service_name : string ; }
form Data : {}
json Body : {}
json Response : { last_service_evaluation_at : string ; ok : true ; service_health : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; } ; }
last_ service_ evaluation_ at : string
ok : true
service_ health : { description : string ; service : string ; status : "healthy" | "degraded" | "down" ; }
description : string
service : string
status : "healthy" | "degraded" | "down"
method : "POST" | "GET"
query Params : {}
route : "/health/service/[service_name]"
Defined in src/lib/seam/connect/route-types.ts:3167
/locks/get
/locks/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { device ?: any ; lock ?: any ; } ; method : "POST" | "GET" ; 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 ?: any ; lock ?: any ; }
Optional
device ?: any
Optional
lock ?: any
method : "POST" | "GET"
query Params : {}
route : "/locks/get"
Defined in src/lib/seam/connect/route-types.ts:3186
/locks/list
/locks/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { devices ?: any ; locks ?: any ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/locks/list" ; }
Type declaration
common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "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 ?: string
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) []
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" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
Optional
user_ identifier_ key ?: string
form Data : {}
json Body : {}
json Response : { devices ?: any ; locks ?: any ; }
Optional
devices ?: any
Optional
locks ?: any
method : "POST" | "GET"
query Params : {}
route : "/locks/list"
Defined in src/lib/seam/connect/route-types.ts:3201
/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:3324
/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:3362
/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" ; } ; } ; 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" ; } ; }
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 : "/noise_sensors/noise_thresholds/create"
Defined in src/lib/seam/connect/route-types.ts:3400
/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:3443
/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 : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/noise_sensors/noise_thresholds/get"
Defined in src/lib/seam/connect/route-types.ts:3482
/noise_ sensors/noise_ thresholds/list
/noise_ sensors/noise_ thresholds/list : { commonParams : { device_id : string ; } ; 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 : "POST" | "GET" ; queryParams : {} ; route : "/noise_sensors/noise_thresholds/list" ; }
Type declaration
common Params : { device_id : string ; }
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 : "POST" | "GET"
query Params : {}
route : "/noise_sensors/noise_thresholds/list"
Defined in src/lib/seam/connect/route-types.ts:3503
/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:3524
/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:3568
/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 ; 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 ; 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 ; 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
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:3579
/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:3620
/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 ; 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" | "GET" ; 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 ; 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 ; 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
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" | "GET"
query Params : {}
route : "/thermostats/climate_setting_schedules/get"
Defined in src/lib/seam/connect/route-types.ts:3631
/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 ; 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" | "GET" ; 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 ; 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 ; 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" | "GET"
query Params : {}
route : "/thermostats/climate_setting_schedules/list"
Defined in src/lib/seam/connect/route-types.ts:3661
/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 ; 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 ; 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 ; 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
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:3691
/thermostats/cool
/thermostats/cool : { commonParams : {} ; formData : {} ; jsonBody : { cooling_set_point_celsius ?: number ; cooling_set_point_fahrenheit ?: number ; device_id : string ; sync ?: boolean ; } ; jsonResponse : {} ; 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 : {}
method : "POST"
query Params : {}
route : "/thermostats/cool"
Defined in src/lib/seam/connect/route-types.ts:3732
/thermostats/get
/thermostats/get : { commonParams : { device_id ?: string ; name ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { thermostat : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; 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 : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } ; }
thermostat : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; }
capabilities_ supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) []
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
errors : { error_code : string ; message : string ; } []
is_ managed : true
location : null | { location_name ?: string ; timezone ?: string ; }
properties : Object
warnings : { message : string ; warning_code : string ; } []
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/thermostats/get"
Defined in src/lib/seam/connect/route-types.ts:3746
/thermostats/heat
/thermostats/heat : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; heating_set_point_celsius ?: number ; heating_set_point_fahrenheit ?: number ; sync ?: boolean ; } ; jsonResponse : {} ; 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 : {}
method : "POST"
query Params : {}
route : "/thermostats/heat"
Defined in src/lib/seam/connect/route-types.ts:4336
/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 : {} ; 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 : {}
method : "POST"
query Params : {}
route : "/thermostats/heat_cool"
Defined in src/lib/seam/connect/route-types.ts:4350
/thermostats/list
/thermostats/list : { commonParams : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "keywe" | "philia" | "samsung" | "seam" | "two_n" ; user_identifier_key ?: string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { thermostats : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/thermostats/list" ; }
Type declaration
common Params : { connect_webview_id ?: string ; connected_account_id ?: string ; connected_account_ids ?: string [] ; created_before ?: string ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) [] ; 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" | "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 ?: string
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat"
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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ) []
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" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
Optional
user_ identifier_ key ?: string
form Data : {}
json Body : {}
json Response : { thermostats : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; }
thermostats : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/thermostats/list"
Defined in src/lib/seam/connect/route-types.ts:4366
/thermostats/off
/thermostats/off : { commonParams : {} ; formData : {} ; jsonBody : { device_id : string ; sync ?: boolean ; } ; jsonResponse : {} ; 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 : {}
method : "POST"
query Params : {}
route : "/thermostats/off"
Defined in src/lib/seam/connect/route-types.ts:5064
/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 : {} ; 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 : {}
method : "POST"
query Params : {}
route : "/thermostats/set_fan_mode"
Defined in src/lib/seam/connect/route-types.ts:5076
/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:5090
/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:5111
/user_ identities/create
/user_ identities/create : { commonParams : { email_address ?: null | string ; user_identity_key ?: null | string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { user_identity : { created_at : string ; email_address ?: 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 ; user_identity_key ?: null | string ; }
Optional
email_ address ?: null | string
Optional
user_ identity_ key ?: null | string
form Data : {}
json Body : {}
json Response : { user_identity : { created_at : string ; email_address ?: null | string ; user_identity_id : string ; user_identity_key ?: null | string ; workspace_id : string ; } ; }
user_ identity : { created_at : string ; email_address ?: null | string ; user_identity_id : string ; user_identity_key ?: null | string ; workspace_id : string ; }
created_ at : string
Optional
email_ address ?: null | string
user_ identity_ id : string
Optional
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:5123
/user_ identities/get
/user_ identities/get : { commonParams : { user_identity_id : string ; } | { user_identity_key : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { user_identity : { created_at : string ; email_address ?: null | string ; user_identity_id : string ; user_identity_key ?: null | string ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; 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 ; email_address ?: null | string ; user_identity_id : string ; user_identity_key ?: null | string ; workspace_id : string ; } ; }
user_ identity : { created_at : string ; email_address ?: null | string ; user_identity_id : string ; user_identity_key ?: null | string ; workspace_id : string ; }
created_ at : string
Optional
email_ address ?: null | string
user_ identity_ id : string
Optional
user_ identity_ key ?: null | string
workspace_ id : string
method : "POST" | "GET"
query Params : {}
route : "/user_identities/get"
Defined in src/lib/seam/connect/route-types.ts:5143
/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:5166
/user_ identities/list_ accessible_ devices
/user_ identities/list_ accessible_ devices : { commonParams : { user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { accessible_devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/user_identities/list_accessible_devices" ; }
Type declaration
common Params : { user_identity_id : string ; }
form Data : {}
json Body : {}
json Response : { accessible_devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } [] ; }
accessible_ devices : { capabilities_supported : ( "access_code" | "lock" | "noise_detection" | "thermostat" | "battery" ) [] ; 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" | "noiseaware_activity_zone" | "minut_sensor" | "ecobee_thermostat" | "nest_thermostat" ; errors : { error_code : string ; message : string ; } [] ; is_managed : true ; location : null | { location_name ?: string ; timezone ?: string ; } ; properties : Object ; warnings : { message : string ; warning_code : string ; } [] ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/user_identities/list_accessible_devices"
Defined in src/lib/seam/connect/route-types.ts:5178
/user_ identities/list_ acs_ users
/user_ identities/list_ acs_ users : { commonParams : { user_identity_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { acs_users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; queryParams : {} ; route : "/user_identities/list_acs_users" ; }
Type declaration
common Params : { user_identity_id : string ; }
form Data : {}
json Body : {}
json Response : { acs_users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } [] ; }
acs_ users : { acs_system_id : string ; acs_user_id : string ; created_at : string ; display_name : string ; email ?: string ; external_type : "pti_user" ; external_type_display_name : string ; full_name ?: string ; is_suspended : boolean ; phone_number ?: string ; workspace_id : string ; } []
method : "POST" | "GET"
query Params : {}
route : "/user_identities/list_acs_users"
Defined in src/lib/seam/connect/route-types.ts:5767
/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:5792
/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:5804
/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:5816
/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:5835
/webhooks/get
/webhooks/get : { commonParams : { webhook_id : string ; } ; formData : {} ; jsonBody : {} ; jsonResponse : { webhook : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } ; } ; method : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/webhooks/get"
Defined in src/lib/seam/connect/route-types.ts:5846
/webhooks/list
/webhooks/list : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { webhooks : { event_types ?: string [] ; secret ?: string ; url : string ; webhook_id : string ; } [] ; } ; method : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/webhooks/list"
Defined in src/lib/seam/connect/route-types.ts:5864
/workspaces/get
/workspaces/get : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { workspace ?: { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } ; } ; method : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/workspaces/get"
Defined in src/lib/seam/connect/route-types.ts:5880
/workspaces/list
/workspaces/list : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { workspaces : { connect_partner_name : null | string ; is_sandbox : boolean ; name : string ; workspace_id : string ; } [] ; } ; method : "POST" | "GET" ; 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 : "POST" | "GET"
query Params : {}
route : "/workspaces/list"
Defined in src/lib/seam/connect/route-types.ts:5898
/workspaces/reset_ sandbox
/workspaces/reset_ sandbox : { commonParams : {} ; formData : {} ; jsonBody : {} ; jsonResponse : { message : string ; } ; method : "POST" ; queryParams : {} ; route : "/workspaces/reset_sandbox" ; }
Type declaration
common Params : {}
form Data : {}
json Body : {}
json Response : { message : string ; }
method : "POST"
query Params : {}
route : "/workspaces/reset_sandbox"
Defined in src/lib/seam/connect/route-types.ts:5914
deprecated: use external_type