@seamapi/http - v1.121.0
GitHub
Preparing search index...
index
SeamHttpAcsEncodersSimulate
Class SeamHttpAcsEncodersSimulate
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
create
Paginator
next
Credential
Encode
Will
Fail
next
Credential
Encode
Will
Succeed
next
Credential
Scan
Will
Fail
next
Credential
Scan
Will
Succeed
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
SeamHttpAcsEncodersSimulate
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpAcsEncodersSimulate
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpAcsEncodersSimulate
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
>
next
Credential
Encode
Will
Fail
nextCredentialEncodeWillFail
(
parameters
:
AcsEncodersSimulateNextCredentialEncodeWillFailParameters
,
options
?:
AcsEncodersSimulateNextCredentialEncodeWillFailOptions
,
)
:
AcsEncodersSimulateNextCredentialEncodeWillFailRequest
Parameters
parameters
:
AcsEncodersSimulateNextCredentialEncodeWillFailParameters
options
:
AcsEncodersSimulateNextCredentialEncodeWillFailOptions
= {}
Returns
AcsEncodersSimulateNextCredentialEncodeWillFailRequest
next
Credential
Encode
Will
Succeed
nextCredentialEncodeWillSucceed
(
parameters
:
AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters
,
options
?:
AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions
,
)
:
AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest
Parameters
parameters
:
AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters
options
:
AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions
= {}
Returns
AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest
next
Credential
Scan
Will
Fail
nextCredentialScanWillFail
(
parameters
:
AcsEncodersSimulateNextCredentialScanWillFailParameters
,
options
?:
AcsEncodersSimulateNextCredentialScanWillFailOptions
,
)
:
AcsEncodersSimulateNextCredentialScanWillFailRequest
Parameters
parameters
:
AcsEncodersSimulateNextCredentialScanWillFailParameters
options
:
AcsEncodersSimulateNextCredentialScanWillFailOptions
= {}
Returns
AcsEncodersSimulateNextCredentialScanWillFailRequest
next
Credential
Scan
Will
Succeed
nextCredentialScanWillSucceed
(
parameters
:
AcsEncodersSimulateNextCredentialScanWillSucceedParameters
,
options
?:
AcsEncodersSimulateNextCredentialScanWillSucceedOptions
,
)
:
AcsEncodersSimulateNextCredentialScanWillSucceedRequest
Parameters
parameters
:
AcsEncodersSimulateNextCredentialScanWillSucceedParameters
options
:
AcsEncodersSimulateNextCredentialScanWillSucceedOptions
= {}
Returns
AcsEncodersSimulateNextCredentialScanWillSucceedRequest
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"
>
,
)
:
SeamHttpAcsEncodersSimulate
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpAcsEncodersSimulate
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpAcsEncodersSimulate
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpAcsEncodersSimulate
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpAcsEncodersSimulate
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpAcsEncodersSimulate
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAcsEncodersSimulate
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAcsEncodersSimulate
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpAcsEncodersSimulate
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpAcsEncodersSimulate
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpAcsEncodersSimulate
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpAcsEncodersSimulate
>
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
next
Credential
Encode
Will
Fail
next
Credential
Encode
Will
Succeed
next
Credential
Scan
Will
Fail
next
Credential
Scan
Will
Succeed
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...