@seamapi/http - v1.121.0
GitHub
Preparing search index...
index
SeamHttpConnectedAccounts
Class SeamHttpConnectedAccounts
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
simulate
Methods
create
Paginator
delete
get
list
sync
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
SeamHttpConnectedAccounts
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpConnectedAccounts
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpConnectedAccounts
Properties
client
client
:
AxiosInstance
Readonly
defaults
defaults
:
Required
<
SeamHttpRequestOptions
>
Readonly
lts
Version
ltsVersion
:
"1.0.0"
= seamApiLtsVersion
Static
lts
Version
ltsVersion
:
string
= seamApiLtsVersion
Accessors
simulate
get
simulate
()
:
SeamHttpConnectedAccountsSimulate
Returns
SeamHttpConnectedAccountsSimulate
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
>
delete
delete
(
parameters
:
ConnectedAccountsDeleteParameters
,
options
?:
ConnectedAccountsDeleteOptions
,
)
:
ConnectedAccountsDeleteRequest
Parameters
parameters
:
ConnectedAccountsDeleteParameters
options
:
ConnectedAccountsDeleteOptions
= {}
Returns
ConnectedAccountsDeleteRequest
get
get
(
parameters
?:
ConnectedAccountsGetParameters
,
options
?:
ConnectedAccountsGetOptions
,
)
:
ConnectedAccountsGetRequest
Parameters
Optional
parameters
:
ConnectedAccountsGetParameters
options
:
ConnectedAccountsGetOptions
= {}
Returns
ConnectedAccountsGetRequest
list
list
(
parameters
?:
ConnectedAccountsListParameters
,
options
?:
ConnectedAccountsListOptions
,
)
:
ConnectedAccountsListRequest
Parameters
Optional
parameters
:
ConnectedAccountsListParameters
options
:
ConnectedAccountsListOptions
= {}
Returns
ConnectedAccountsListRequest
sync
sync
(
parameters
:
ConnectedAccountsSyncParameters
,
options
?:
ConnectedAccountsSyncOptions
,
)
:
ConnectedAccountsSyncRequest
Parameters
parameters
:
ConnectedAccountsSyncParameters
options
:
ConnectedAccountsSyncOptions
= {}
Returns
ConnectedAccountsSyncRequest
update
update
(
parameters
:
ConnectedAccountsUpdateParameters
,
options
?:
ConnectedAccountsUpdateOptions
,
)
:
ConnectedAccountsUpdateRequest
Parameters
parameters
:
ConnectedAccountsUpdateParameters
options
:
ConnectedAccountsUpdateOptions
= {}
Returns
ConnectedAccountsUpdateRequest
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"
>
,
)
:
SeamHttpConnectedAccounts
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpConnectedAccounts
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpConnectedAccounts
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpConnectedAccounts
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpConnectedAccounts
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpConnectedAccounts
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpConnectedAccounts
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpConnectedAccounts
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpConnectedAccounts
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpConnectedAccounts
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpConnectedAccounts
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpConnectedAccounts
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
simulate
Methods
create
Paginator
delete
get
list
sync
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...