GitHub
Preparing search index...
The search index is not available
@seamapi/http - v1.17.0
@seamapi/http
connect
SeamHttp
Class SeamHttp
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
access
Codes
acs
action
Attempts
client
Sessions
connected
Accounts
connect
Webviews
devices
events
locks
networks
noise
Sensors
phones
thermostats
user
Identities
webhooks
workspaces
Methods
update
Client
Session
Token
from
Api
Key
from
Client
from
Client
Session
Token
from
Console
Session
Token
from
Personal
Access
Token
from
Publishable
Key
Constructors
constructor
new
Seam
Http
(
apiKeyOrOptions
?
)
:
SeamHttp
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttp
Properties
client
client
:
AxiosInstance
Readonly
defaults
defaults
:
Required
<
SeamHttpRequestOptions
>
Readonly
lts
Version
lts
Version
:
"1.0.0"
= seamApiLtsVersion
Static
lts
Version
lts
Version
:
string
= seamApiLtsVersion
Accessors
access
Codes
get
accessCodes
(
)
:
SeamHttpAccessCodes
Returns
SeamHttpAccessCodes
acs
get
acs
(
)
:
SeamHttpAcs
Returns
SeamHttpAcs
action
Attempts
get
actionAttempts
(
)
:
SeamHttpActionAttempts
Returns
SeamHttpActionAttempts
client
Sessions
get
clientSessions
(
)
:
SeamHttpClientSessions
Returns
SeamHttpClientSessions
connected
Accounts
get
connectedAccounts
(
)
:
SeamHttpConnectedAccounts
Returns
SeamHttpConnectedAccounts
connect
Webviews
get
connectWebviews
(
)
:
SeamHttpConnectWebviews
Returns
SeamHttpConnectWebviews
devices
get
devices
(
)
:
SeamHttpDevices
Returns
SeamHttpDevices
events
get
events
(
)
:
SeamHttpEvents
Returns
SeamHttpEvents
locks
get
locks
(
)
:
SeamHttpLocks
Returns
SeamHttpLocks
networks
get
networks
(
)
:
SeamHttpNetworks
Returns
SeamHttpNetworks
noise
Sensors
get
noiseSensors
(
)
:
SeamHttpNoiseSensors
Returns
SeamHttpNoiseSensors
phones
get
phones
(
)
:
SeamHttpPhones
Returns
SeamHttpPhones
thermostats
get
thermostats
(
)
:
SeamHttpThermostats
Returns
SeamHttpThermostats
user
Identities
get
userIdentities
(
)
:
SeamHttpUserIdentities
Returns
SeamHttpUserIdentities
webhooks
get
webhooks
(
)
:
SeamHttpWebhooks
Returns
SeamHttpWebhooks
workspaces
get
workspaces
(
)
:
Omit
<
SeamHttpWorkspaces
,
"create"
>
Returns
Omit
<
SeamHttpWorkspaces
,
"create"
>
Methods
update
Client
Session
Token
update
Client
Session
Token
(
clientSessionToken
)
:
Promise
<
void
>
Parameters
clientSessionToken
:
string
Returns
Promise
<
void
>
Static
from
Api
Key
from
Api
Key
(
apiKey
,
options
?
)
:
SeamHttp
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttp
Static
from
Client
from
Client
(
client
,
options
?
)
:
SeamHttp
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttp
Static
from
Client
Session
Token
from
Client
Session
Token
(
clientSessionToken
,
options
?
)
:
SeamHttp
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttp
Static
from
Console
Session
Token
from
Console
Session
Token
(
consoleSessionToken
,
workspaceId
,
options
?
)
:
SeamHttp
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
>
= {}
Returns
SeamHttp
Static
from
Personal
Access
Token
from
Personal
Access
Token
(
personalAccessToken
,
workspaceId
,
options
?
)
:
SeamHttp
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"workspaceId"
|
"personalAccessToken"
>
= {}
Returns
SeamHttp
Static
from
Publishable
Key
from
Publishable
Key
(
publishableKey
,
userIdentifierKey
,
options
?
)
:
Promise
<
SeamHttp
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttp
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
access
Codes
acs
action
Attempts
client
Sessions
connected
Accounts
connect
Webviews
devices
events
locks
networks
noise
Sensors
phones
thermostats
user
Identities
webhooks
workspaces
Methods
update
Client
Session
Token
from
Api
Key
from
Client
from
Client
Session
Token
from
Console
Session
Token
from
Personal
Access
Token
from
Publishable
Key
GitHub
@seamapi/http - v1.17.0
Loading...