damen-triton
Preparing search index...
client
Function client
client
(
config
:
ClientConfig
,
)
:
{
metadata
:
(
options
?:
Partial
<
{
"subscription-key"
:
string
;
yardNumber
:
string
}
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
{
sensorInfo
:
SensorInfo
[]
;
vesselInfo
:
VesselInfo
}
>
;
request
:
<
P
extends
"/api/v1/metadata/vessels"
|
(keyof SensorService)
|
"/api/v1/tokens"
,
M
extends
"GET"
|
"POST"
|
"PUT"
|
"DELETE"
,
>
(
path
:
P
,
method
:
M
,
args
:
Params
<
P
,
M
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
Ret
<
P
,
M
>
>
;
sensors
:
(
vessel_id
?:
string
,
)
=>
{
data
:
(
query
?:
Partial
<
{
"subscription-key"
:
string
;
timespan
:
string
}
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
object
>
;
latest_readings
:
(
query
?:
Partial
<
{
id
?:
string
|
number
|
string
[]
|
number
[]
;
isManualInput
:
boolean
;
"subscription-key"
:
string
;
virtualsensor_ids
?:
string
[]
|
number
[]
;
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
{
nocontentsensors
:
string
[]
;
sensors
:
SensorReading
[]
}
>
;
list
:
(
requestInit
?:
RequestInit
)
=>
Promise
<
SensorInfo
[]
>
;
sensor
:
(
sensor_id
:
string
,
)
=>
{
latest_reading
:
(
query
?:
Partial
<
{
isManualInput
?:
boolean
;
"subscription-key"
:
string
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
SensorReading
>
;
readings
:
(
query
?:
Partial
<
{
endtime
:
number
;
starttime
:
number
;
"subscription-key"
:
string
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
object
>
;
}
;
virtualsensors
:
{
latest_reading
:
(
query
?:
Partial
<
{
"subscription-key"
:
string
;
virtualsensor_id
:
string
|
number
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
object
>
;
}
;
}
;
token
:
{
create
:
(
body
:
{
$encoding
:
"application/x-www-form-urlencoded"
;
client_id
:
string
;
client_secret
:
string
;
grant_type
:
string
;
scope
:
string
;
}
,
query
?:
Partial
<
{
"subscription-key"
:
string
}
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
{
access_token
:
string
;
expires_in
:
number
;
ext_expires_in
:
number
;
token_type
:
string
;
}
,
>
;
renew
:
(
force
?:
boolean
,
requestInit
?:
RequestInit
)
=>
Promise
<
string
>
;
valid
:
()
=>
boolean
;
}
;
}
Parameters
config
:
ClientConfig
Returns
{
metadata
:
(
options
?:
Partial
<
{
"subscription-key"
:
string
;
yardNumber
:
string
}
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
{
sensorInfo
:
SensorInfo
[]
;
vesselInfo
:
VesselInfo
}
>
;
request
:
<
P
extends
"/api/v1/metadata/vessels"
|
(keyof SensorService)
|
"/api/v1/tokens"
,
M
extends
"GET"
|
"POST"
|
"PUT"
|
"DELETE"
,
>
(
path
:
P
,
method
:
M
,
args
:
Params
<
P
,
M
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
Ret
<
P
,
M
>
>
;
sensors
:
(
vessel_id
?:
string
,
)
=>
{
data
:
(
query
?:
Partial
<
{
"subscription-key"
:
string
;
timespan
:
string
}
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
object
>
;
latest_readings
:
(
query
?:
Partial
<
{
id
?:
string
|
number
|
string
[]
|
number
[]
;
isManualInput
:
boolean
;
"subscription-key"
:
string
;
virtualsensor_ids
?:
string
[]
|
number
[]
;
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
{
nocontentsensors
:
string
[]
;
sensors
:
SensorReading
[]
}
>
;
list
:
(
requestInit
?:
RequestInit
)
=>
Promise
<
SensorInfo
[]
>
;
sensor
:
(
sensor_id
:
string
,
)
=>
{
latest_reading
:
(
query
?:
Partial
<
{
isManualInput
?:
boolean
;
"subscription-key"
:
string
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
SensorReading
>
;
readings
:
(
query
?:
Partial
<
{
endtime
:
number
;
starttime
:
number
;
"subscription-key"
:
string
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
object
>
;
}
;
virtualsensors
:
{
latest_reading
:
(
query
?:
Partial
<
{
"subscription-key"
:
string
;
virtualsensor_id
:
string
|
number
}
,
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
object
>
;
}
;
}
;
token
:
{
create
:
(
body
:
{
$encoding
:
"application/x-www-form-urlencoded"
;
client_id
:
string
;
client_secret
:
string
;
grant_type
:
string
;
scope
:
string
;
}
,
query
?:
Partial
<
{
"subscription-key"
:
string
}
>
,
requestInit
?:
RequestInit
,
)
=>
Promise
<
{
access_token
:
string
;
expires_in
:
number
;
ext_expires_in
:
number
;
token_type
:
string
;
}
,
>
;
renew
:
(
force
?:
boolean
,
requestInit
?:
RequestInit
)
=>
Promise
<
string
>
;
valid
:
()
=>
boolean
;
}
;
}
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
damen-triton
Loading...