@seamapi/http - v1.121.0
GitHub
Preparing search index...
index
SeamHttpAccessCodesUnmanaged
Class SeamHttpAccessCodesUnmanaged
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
convert
To
Managed
create
Paginator
delete
get
list
update
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
SeamHttpAccessCodesUnmanaged
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpAccessCodesUnmanaged
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpAccessCodesUnmanaged
Properties
client
client
:
AxiosInstance
Readonly
defaults
defaults
:
Required
<
SeamHttpRequestOptions
>
Readonly
lts
Version
ltsVersion
:
"1.0.0"
= seamApiLtsVersion
Static
lts
Version
ltsVersion
:
string
= seamApiLtsVersion
Methods
convert
To
Managed
convertToManaged
(
parameters
:
AccessCodesUnmanagedConvertToManagedParameters
,
options
?:
AccessCodesUnmanagedConvertToManagedOptions
,
)
:
AccessCodesUnmanagedConvertToManagedRequest
Parameters
parameters
:
AccessCodesUnmanagedConvertToManagedParameters
options
:
AccessCodesUnmanagedConvertToManagedOptions
= {}
Returns
AccessCodesUnmanagedConvertToManagedRequest
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
:
AccessCodesUnmanagedDeleteParameters
,
options
?:
AccessCodesUnmanagedDeleteOptions
,
)
:
AccessCodesUnmanagedDeleteRequest
Parameters
parameters
:
AccessCodesUnmanagedDeleteParameters
options
:
AccessCodesUnmanagedDeleteOptions
= {}
Returns
AccessCodesUnmanagedDeleteRequest
get
get
(
parameters
?:
AccessCodesUnmanagedGetParameters
,
options
?:
AccessCodesUnmanagedGetOptions
,
)
:
AccessCodesUnmanagedGetRequest
Parameters
Optional
parameters
:
AccessCodesUnmanagedGetParameters
options
:
AccessCodesUnmanagedGetOptions
= {}
Returns
AccessCodesUnmanagedGetRequest
list
list
(
parameters
:
AccessCodesUnmanagedListParameters
,
options
?:
AccessCodesUnmanagedListOptions
,
)
:
AccessCodesUnmanagedListRequest
Parameters
parameters
:
AccessCodesUnmanagedListParameters
options
:
AccessCodesUnmanagedListOptions
= {}
Returns
AccessCodesUnmanagedListRequest
update
update
(
parameters
:
AccessCodesUnmanagedUpdateParameters
,
options
?:
AccessCodesUnmanagedUpdateOptions
,
)
:
AccessCodesUnmanagedUpdateRequest
Parameters
parameters
:
AccessCodesUnmanagedUpdateParameters
options
:
AccessCodesUnmanagedUpdateOptions
= {}
Returns
AccessCodesUnmanagedUpdateRequest
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"
>
,
)
:
SeamHttpAccessCodesUnmanaged
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpAccessCodesUnmanaged
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpAccessCodesUnmanaged
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpAccessCodesUnmanaged
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpAccessCodesUnmanaged
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpAccessCodesUnmanaged
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAccessCodesUnmanaged
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAccessCodesUnmanaged
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAccessCodesUnmanaged
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAccessCodesUnmanaged
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpAccessCodesUnmanaged
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpAccessCodesUnmanaged
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
convert
To
Managed
create
Paginator
delete
get
list
update
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...