Integration App SDK - v0.2.0
Console
React Lib
REST API
Preparing search index...
RestApiClientConstructorOptions
Interface RestApiClientConstructorOptions
interface
RestApiClientConstructorOptions
{
baseUri
?:
any
;
proxyUri
?:
any
;
headers
?:
{
[
key
:
string
]:
any
}
;
auth
?:
{
username
:
any
;
password
:
any
}
;
query
?:
{
[
key
:
string
]:
any
}
;
returnFullResponse
?:
boolean
;
responseHandlers
?:
RestApiClientResponseHandler
[]
;
dynamicOptions
?:
(
input
:
RestApiClientInput
)
=>
RestApiClientOptions
;
binary
?:
boolean
;
stream
?:
boolean
;
onError
?:
(
error
:
any
)
=>
any
;
overrides
?:
RestApiClientOverride
[]
;
httpsAgent
?:
Agent
;
}
Hierarchy (
View Summary
)
RestApiClientOptions
RestApiClientConstructorOptions
Index
Properties
base
Uri?
proxy
Uri?
headers?
auth?
query?
return
Full
Response?
response
Handlers?
dynamic
Options?
binary?
stream?
on
Error?
overrides?
https
Agent?
Properties
Optional
base
Uri
baseUri
?:
any
Optional
proxy
Uri
proxyUri
?:
any
Optional
headers
headers
?:
{
[
key
:
string
]:
any
}
Optional
auth
auth
?:
{
username
:
any
;
password
:
any
}
Optional
query
query
?:
{
[
key
:
string
]:
any
}
Optional
return
Full
Response
returnFullResponse
?:
boolean
Optional
response
Handlers
responseHandlers
?:
RestApiClientResponseHandler
[]
Optional
dynamic
Options
dynamicOptions
?:
(
input
:
RestApiClientInput
)
=>
RestApiClientOptions
Optional
binary
binary
?:
boolean
Deprecated
use responseType instead
Optional
stream
stream
?:
boolean
Deprecated
use responseType instead
Optional
on
Error
onError
?:
(
error
:
any
)
=>
any
Deprecated
use responseHandlers
Optional
overrides
overrides
?:
RestApiClientOverride
[]
Optional
https
Agent
httpsAgent
?:
Agent
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
base
Uri
proxy
Uri
headers
auth
query
return
Full
Response
response
Handlers
dynamic
Options
binary
stream
on
Error
overrides
https
Agent
Console
React Lib
REST API
Integration App SDK - v0.2.0
Loading...
Deprecated