@seamapi/http - v1.121.0
GitHub
Preparing search index...
index
SeamHttpLocksSimulate
Class SeamHttpLocksSimulate
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
create
Paginator
keypad
Code
Entry
manual
Lock
Via
Keypad
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
SeamHttpLocksSimulate
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpLocksSimulate
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpLocksSimulate
Properties
client
client
:
AxiosInstance
Readonly
defaults
defaults
:
Required
<
SeamHttpRequestOptions
>
Readonly
lts
Version
ltsVersion
:
"1.0.0"
= seamApiLtsVersion
Static
lts
Version
ltsVersion
:
string
= seamApiLtsVersion
Methods
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
>
keypad
Code
Entry
keypadCodeEntry
(
parameters
:
LocksSimulateKeypadCodeEntryParameters
,
options
?:
LocksSimulateKeypadCodeEntryOptions
,
)
:
LocksSimulateKeypadCodeEntryRequest
Parameters
parameters
:
LocksSimulateKeypadCodeEntryParameters
options
:
LocksSimulateKeypadCodeEntryOptions
= {}
Returns
LocksSimulateKeypadCodeEntryRequest
manual
Lock
Via
Keypad
manualLockViaKeypad
(
parameters
:
LocksSimulateManualLockViaKeypadParameters
,
options
?:
LocksSimulateManualLockViaKeypadOptions
,
)
:
LocksSimulateManualLockViaKeypadRequest
Parameters
parameters
:
LocksSimulateManualLockViaKeypadParameters
options
:
LocksSimulateManualLockViaKeypadOptions
= {}
Returns
LocksSimulateManualLockViaKeypadRequest
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"
>
,
)
:
SeamHttpLocksSimulate
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpLocksSimulate
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpLocksSimulate
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpLocksSimulate
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpLocksSimulate
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpLocksSimulate
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpLocksSimulate
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpLocksSimulate
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpLocksSimulate
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpLocksSimulate
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpLocksSimulate
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpLocksSimulate
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
create
Paginator
keypad
Code
Entry
manual
Lock
Via
Keypad
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.121.0
Loading...