@seamapi/http - v1.123.0
GitHub
Preparing search index...
index
SeamHttpAcsEntrances
Class SeamHttpAcsEntrances
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
create
Paginator
get
grant
Access
list
list
Credentials
With
Access
unlock
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
SeamHttpAcsEntrances
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpAcsEntrances
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpAcsEntrances
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
>
get
get
(
parameters
:
AcsEntrancesGetParameters
,
options
?:
AcsEntrancesGetOptions
,
)
:
AcsEntrancesGetRequest
Parameters
parameters
:
AcsEntrancesGetParameters
options
:
AcsEntrancesGetOptions
= {}
Returns
AcsEntrancesGetRequest
grant
Access
grantAccess
(
parameters
:
AcsEntrancesGrantAccessParameters
,
options
?:
AcsEntrancesGrantAccessOptions
,
)
:
AcsEntrancesGrantAccessRequest
Parameters
parameters
:
AcsEntrancesGrantAccessParameters
options
:
AcsEntrancesGrantAccessOptions
= {}
Returns
AcsEntrancesGrantAccessRequest
list
list
(
parameters
?:
AcsEntrancesListParameters
,
options
?:
AcsEntrancesListOptions
,
)
:
AcsEntrancesListRequest
Parameters
Optional
parameters
:
AcsEntrancesListParameters
options
:
AcsEntrancesListOptions
= {}
Returns
AcsEntrancesListRequest
list
Credentials
With
Access
listCredentialsWithAccess
(
parameters
:
AcsEntrancesListCredentialsWithAccessParameters
,
options
?:
AcsEntrancesListCredentialsWithAccessOptions
,
)
:
AcsEntrancesListCredentialsWithAccessRequest
Parameters
parameters
:
AcsEntrancesListCredentialsWithAccessParameters
options
:
AcsEntrancesListCredentialsWithAccessOptions
= {}
Returns
AcsEntrancesListCredentialsWithAccessRequest
unlock
unlock
(
parameters
:
AcsEntrancesUnlockParameters
,
options
?:
AcsEntrancesUnlockOptions
,
)
:
AcsEntrancesUnlockRequest
Parameters
parameters
:
AcsEntrancesUnlockParameters
options
:
AcsEntrancesUnlockOptions
= {}
Returns
AcsEntrancesUnlockRequest
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"
>
,
)
:
SeamHttpAcsEntrances
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpAcsEntrances
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpAcsEntrances
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpAcsEntrances
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpAcsEntrances
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpAcsEntrances
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAcsEntrances
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAcsEntrances
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAcsEntrances
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAcsEntrances
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpAcsEntrances
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpAcsEntrances
>
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
get
grant
Access
list
list
Credentials
With
Access
unlock
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...