GitHub
Preparing search index...
The search index is not available
@seamapi/http - v1.35.0
@seamapi/http
connect
SeamHttpAcs
Class SeamHttpAcs
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
access
Groups
credentials
encoders
entrances
systems
users
Methods
create
Paginator
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
Acs
(
apiKeyOrOptions
?
)
:
SeamHttpAcs
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpAcs
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
Groups
get
accessGroups
(
)
:
SeamHttpAcsAccessGroups
Returns
SeamHttpAcsAccessGroups
credentials
get
credentials
(
)
:
SeamHttpAcsCredentials
Returns
SeamHttpAcsCredentials
encoders
get
encoders
(
)
:
SeamHttpAcsEncoders
Returns
SeamHttpAcsEncoders
entrances
get
entrances
(
)
:
SeamHttpAcsEntrances
Returns
SeamHttpAcsEntrances
systems
get
systems
(
)
:
SeamHttpAcsSystems
Returns
SeamHttpAcsSystems
users
get
users
(
)
:
SeamHttpAcsUsers
Returns
SeamHttpAcsUsers
Methods
create
Paginator
create
Paginator
<
const
TResponse
,
const
TResponseKey
>
(
request
)
:
SeamPaginator
<
TResponse
,
TResponseKey
>
Type Parameters
const
TResponse
const
TResponseKey
extends
string
|
number
|
symbol
Parameters
request
:
SeamHttpRequest
<
TResponse
,
TResponseKey
>
Returns
SeamPaginator
<
TResponse
,
TResponseKey
>
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
?
)
:
SeamHttpAcs
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpAcs
Static
from
Client
from
Client
(
client
,
options
?
)
:
SeamHttpAcs
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpAcs
Static
from
Client
Session
Token
from
Client
Session
Token
(
clientSessionToken
,
options
?
)
:
SeamHttpAcs
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpAcs
Static
from
Console
Session
Token
from
Console
Session
Token
(
consoleSessionToken
,
workspaceId
,
options
?
)
:
SeamHttpAcs
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
>
= {}
Returns
SeamHttpAcs
Static
from
Personal
Access
Token
from
Personal
Access
Token
(
personalAccessToken
,
workspaceId
,
options
?
)
:
SeamHttpAcs
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"workspaceId"
|
"personalAccessToken"
>
= {}
Returns
SeamHttpAcs
Static
from
Publishable
Key
from
Publishable
Key
(
publishableKey
,
userIdentifierKey
,
options
?
)
:
Promise
<
SeamHttpAcs
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpAcs
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
access
Groups
credentials
encoders
entrances
systems
users
Methods
create
Paginator
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.35.0
Loading...