@seamapi/http - v1.123.0
GitHub
Preparing search index...
index
SeamHttpDevicesSimulate
Class SeamHttpDevicesSimulate
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
connect
connect
To
Hub
create
Paginator
disconnect
disconnect
From
Hub
paid
Subscription
remove
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
SeamHttpDevicesSimulate
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpDevicesSimulate
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpDevicesSimulate
Properties
client
client
:
AxiosInstance
Readonly
defaults
defaults
:
Required
<
SeamHttpRequestOptions
>
Readonly
lts
Version
ltsVersion
:
"1.0.0"
= seamApiLtsVersion
Static
lts
Version
ltsVersion
:
string
= seamApiLtsVersion
Methods
connect
connect
(
parameters
:
DevicesSimulateConnectParameters
,
options
?:
DevicesSimulateConnectOptions
,
)
:
DevicesSimulateConnectRequest
Parameters
parameters
:
DevicesSimulateConnectParameters
options
:
DevicesSimulateConnectOptions
= {}
Returns
DevicesSimulateConnectRequest
connect
To
Hub
connectToHub
(
parameters
:
DevicesSimulateConnectToHubParameters
,
options
?:
DevicesSimulateConnectToHubOptions
,
)
:
DevicesSimulateConnectToHubRequest
Parameters
parameters
:
DevicesSimulateConnectToHubParameters
options
:
DevicesSimulateConnectToHubOptions
= {}
Returns
DevicesSimulateConnectToHubRequest
create
Paginator
createPaginator
<
const
TResponse
,
const
TResponseKey
extends
string
|
number
|
symbol
,
>
(
request
:
SeamHttpRequest
<
TResponse
,
TResponseKey
>
,
)
:
SeamPaginator
<
TResponse
,
TResponseKey
>
Type Parameters
const
TResponse
const
TResponseKey
extends
string
|
number
|
symbol
Parameters
request
:
SeamHttpRequest
<
TResponse
,
TResponseKey
>
Returns
SeamPaginator
<
TResponse
,
TResponseKey
>
disconnect
disconnect
(
parameters
:
DevicesSimulateDisconnectParameters
,
options
?:
DevicesSimulateDisconnectOptions
,
)
:
DevicesSimulateDisconnectRequest
Parameters
parameters
:
DevicesSimulateDisconnectParameters
options
:
DevicesSimulateDisconnectOptions
= {}
Returns
DevicesSimulateDisconnectRequest
disconnect
From
Hub
disconnectFromHub
(
parameters
:
DevicesSimulateDisconnectFromHubParameters
,
options
?:
DevicesSimulateDisconnectFromHubOptions
,
)
:
DevicesSimulateDisconnectFromHubRequest
Parameters
parameters
:
DevicesSimulateDisconnectFromHubParameters
options
:
DevicesSimulateDisconnectFromHubOptions
= {}
Returns
DevicesSimulateDisconnectFromHubRequest
paid
Subscription
paidSubscription
(
parameters
:
DevicesSimulatePaidSubscriptionParameters
,
options
?:
DevicesSimulatePaidSubscriptionOptions
,
)
:
DevicesSimulatePaidSubscriptionRequest
Parameters
parameters
:
DevicesSimulatePaidSubscriptionParameters
options
:
DevicesSimulatePaidSubscriptionOptions
= {}
Returns
DevicesSimulatePaidSubscriptionRequest
remove
remove
(
parameters
:
DevicesSimulateRemoveParameters
,
options
?:
DevicesSimulateRemoveOptions
,
)
:
DevicesSimulateRemoveRequest
Parameters
parameters
:
DevicesSimulateRemoveParameters
options
:
DevicesSimulateRemoveOptions
= {}
Returns
DevicesSimulateRemoveRequest
update
Client
Session
Token
updateClientSessionToken
(
clientSessionToken
:
string
)
:
Promise
<
void
>
Parameters
clientSessionToken
:
string
Returns
Promise
<
void
>
Static
from
Api
Key
fromApiKey
(
apiKey
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
,
)
:
SeamHttpDevicesSimulate
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpDevicesSimulate
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpDevicesSimulate
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpDevicesSimulate
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpDevicesSimulate
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpDevicesSimulate
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpDevicesSimulate
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpDevicesSimulate
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpDevicesSimulate
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpDevicesSimulate
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpDevicesSimulate
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpDevicesSimulate
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
connect
connect
To
Hub
create
Paginator
disconnect
disconnect
From
Hub
paid
Subscription
remove
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.123.0
Loading...