GitHub
Preparing search index...
The search index is not available
@seamapi/http - v1.40.1
@seamapi/http
connect
SeamHttpSeamCustomerV1
Class SeamHttpSeamCustomerV1
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
portals
settings
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
Seam
Customer
V1
(
apiKeyOrOptions
?
)
:
SeamHttpSeamCustomerV1
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpSeamCustomerV1
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
portals
get
portals
(
)
:
SeamHttpSeamCustomerV1Portals
Returns
SeamHttpSeamCustomerV1Portals
settings
get
settings
(
)
:
SeamHttpSeamCustomerV1Settings
Returns
SeamHttpSeamCustomerV1Settings
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
?
)
:
SeamHttpSeamCustomerV1
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpSeamCustomerV1
Static
from
Client
from
Client
(
client
,
options
?
)
:
SeamHttpSeamCustomerV1
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpSeamCustomerV1
Static
from
Client
Session
Token
from
Client
Session
Token
(
clientSessionToken
,
options
?
)
:
SeamHttpSeamCustomerV1
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpSeamCustomerV1
Static
from
Console
Session
Token
from
Console
Session
Token
(
consoleSessionToken
,
workspaceId
,
options
?
)
:
SeamHttpSeamCustomerV1
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
>
= {}
Returns
SeamHttpSeamCustomerV1
Static
from
Personal
Access
Token
from
Personal
Access
Token
(
personalAccessToken
,
workspaceId
,
options
?
)
:
SeamHttpSeamCustomerV1
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"workspaceId"
|
"personalAccessToken"
>
= {}
Returns
SeamHttpSeamCustomerV1
Static
from
Publishable
Key
from
Publishable
Key
(
publishableKey
,
userIdentifierKey
,
options
?
)
:
Promise
<
SeamHttpSeamCustomerV1
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpSeamCustomerV1
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Accessors
portals
settings
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.40.1
Loading...