@seamapi/http - v1.123.0
GitHub
Preparing search index...
index
SeamHttpAcsAccessGroups
Class SeamHttpAcsAccessGroups
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
unmanaged
Methods
add
User
create
Paginator
delete
get
list
list
Accessible
Entrances
list
Users
remove
User
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
SeamHttpAcsAccessGroups
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpAcsAccessGroups
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpAcsAccessGroups
Properties
client
client
:
AxiosInstance
Readonly
defaults
defaults
:
Required
<
SeamHttpRequestOptions
>
Readonly
lts
Version
ltsVersion
:
"1.0.0"
= seamApiLtsVersion
Static
lts
Version
ltsVersion
:
string
= seamApiLtsVersion
Accessors
unmanaged
get
unmanaged
()
:
SeamHttpAcsAccessGroupsUnmanaged
Returns
SeamHttpAcsAccessGroupsUnmanaged
Methods
add
User
addUser
(
parameters
:
AcsAccessGroupsAddUserParameters
,
options
?:
AcsAccessGroupsAddUserOptions
,
)
:
AcsAccessGroupsAddUserRequest
Parameters
parameters
:
AcsAccessGroupsAddUserParameters
options
:
AcsAccessGroupsAddUserOptions
= {}
Returns
AcsAccessGroupsAddUserRequest
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
>
delete
delete
(
parameters
:
AcsAccessGroupsDeleteParameters
,
options
?:
AcsAccessGroupsDeleteOptions
,
)
:
AcsAccessGroupsDeleteRequest
Parameters
parameters
:
AcsAccessGroupsDeleteParameters
options
:
AcsAccessGroupsDeleteOptions
= {}
Returns
AcsAccessGroupsDeleteRequest
get
get
(
parameters
:
AcsAccessGroupsGetParameters
,
options
?:
AcsAccessGroupsGetOptions
,
)
:
AcsAccessGroupsGetRequest
Parameters
parameters
:
AcsAccessGroupsGetParameters
options
:
AcsAccessGroupsGetOptions
= {}
Returns
AcsAccessGroupsGetRequest
list
list
(
parameters
?:
AcsAccessGroupsListParameters
,
options
?:
AcsAccessGroupsListOptions
,
)
:
AcsAccessGroupsListRequest
Parameters
Optional
parameters
:
AcsAccessGroupsListParameters
options
:
AcsAccessGroupsListOptions
= {}
Returns
AcsAccessGroupsListRequest
list
Accessible
Entrances
listAccessibleEntrances
(
parameters
:
AcsAccessGroupsListAccessibleEntrancesParameters
,
options
?:
AcsAccessGroupsListAccessibleEntrancesOptions
,
)
:
AcsAccessGroupsListAccessibleEntrancesRequest
Parameters
parameters
:
AcsAccessGroupsListAccessibleEntrancesParameters
options
:
AcsAccessGroupsListAccessibleEntrancesOptions
= {}
Returns
AcsAccessGroupsListAccessibleEntrancesRequest
list
Users
listUsers
(
parameters
:
AcsAccessGroupsListUsersParameters
,
options
?:
AcsAccessGroupsListUsersOptions
,
)
:
AcsAccessGroupsListUsersRequest
Parameters
parameters
:
AcsAccessGroupsListUsersParameters
options
:
AcsAccessGroupsListUsersOptions
= {}
Returns
AcsAccessGroupsListUsersRequest
remove
User
removeUser
(
parameters
:
AcsAccessGroupsRemoveUserParameters
,
options
?:
AcsAccessGroupsRemoveUserOptions
,
)
:
AcsAccessGroupsRemoveUserRequest
Parameters
parameters
:
AcsAccessGroupsRemoveUserParameters
options
:
AcsAccessGroupsRemoveUserOptions
= {}
Returns
AcsAccessGroupsRemoveUserRequest
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"
>
,
)
:
SeamHttpAcsAccessGroups
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpAcsAccessGroups
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpAcsAccessGroups
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpAcsAccessGroups
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpAcsAccessGroups
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpAcsAccessGroups
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAcsAccessGroups
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAcsAccessGroups
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAcsAccessGroups
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAcsAccessGroups
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpAcsAccessGroups
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpAcsAccessGroups
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
unmanaged
Methods
add
User
create
Paginator
delete
get
list
list
Accessible
Entrances
list
Users
remove
User
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...