@seamapi/http - v1.70.0
GitHub
Preparing search index...
index
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Class SeamHttpSeamPartnerV1BuildingBlocksSpaces
Index
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
auto
Map
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
SeamHttpSeamPartnerV1BuildingBlocksSpaces
(
apiKeyOrOptions
?:
string
|
SeamHttpOptions
,
)
:
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Parameters
apiKeyOrOptions
:
string
|
SeamHttpOptions
= {}
Returns
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Properties
client
client
:
AxiosInstance
Readonly
defaults
defaults
:
Required
<
SeamHttpRequestOptions
>
Readonly
lts
Version
ltsVersion
:
"1.0.0"
= seamApiLtsVersion
Static
lts
Version
ltsVersion
:
string
= seamApiLtsVersion
Methods
auto
Map
autoMap
(
parameters
?:
{
collection_key
?:
string
}
,
options
?:
SeamPartnerV1BuildingBlocksSpacesAutoMapOptions
,
)
:
SeamPartnerV1BuildingBlocksSpacesAutoMapRequest
Parameters
Optional
parameters
:
{
collection_key
?:
string
}
Optional
collection_key
?:
string
Collection key.
options
:
SeamPartnerV1BuildingBlocksSpacesAutoMapOptions
= {}
Returns
SeamPartnerV1BuildingBlocksSpacesAutoMapRequest
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
>
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"
>
,
)
:
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Parameters
apiKey
:
string
options
:
Omit
<
SeamHttpOptionsWithApiKey
,
"apiKey"
>
= {}
Returns
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Static
from
Client
fromClient
(
client
:
AxiosInstance
,
options
?:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
,
)
:
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Parameters
client
:
AxiosInstance
options
:
Omit
<
SeamHttpOptionsWithClient
,
"client"
>
= {}
Returns
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Static
from
Client
Session
Token
fromClientSessionToken
(
clientSessionToken
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
,
)
:
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Parameters
clientSessionToken
:
string
options
:
Omit
<
SeamHttpOptionsWithClientSessionToken
,
"clientSessionToken"
>
= {}
Returns
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Static
from
Console
Session
Token
fromConsoleSessionToken
(
consoleSessionToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Parameters
consoleSessionToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithConsoleSessionToken
,
"consoleSessionToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Static
from
Personal
Access
Token
fromPersonalAccessToken
(
personalAccessToken
:
string
,
workspaceId
:
string
,
options
?:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
,
)
:
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Parameters
personalAccessToken
:
string
workspaceId
:
string
options
:
Omit
<
SeamHttpOptionsWithPersonalAccessToken
,
"personalAccessToken"
|
"workspaceId"
,
>
= {}
Returns
SeamHttpSeamPartnerV1BuildingBlocksSpaces
Static
from
Publishable
Key
fromPublishableKey
(
publishableKey
:
string
,
userIdentifierKey
:
string
,
options
?:
SeamHttpFromPublishableKeyOptions
,
)
:
Promise
<
SeamHttpSeamPartnerV1BuildingBlocksSpaces
>
Parameters
publishableKey
:
string
userIdentifierKey
:
string
options
:
SeamHttpFromPublishableKeyOptions
= {}
Returns
Promise
<
SeamHttpSeamPartnerV1BuildingBlocksSpaces
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
client
defaults
lts
Version
lts
Version
Methods
auto
Map
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.70.0
Loading...
Collection key.