User / getNotifications
TypeScript
Get notifications for the logged in user. If the requested notification wasn't returned, it means that the notification doesn't exist.
Request parameters
{
/** Which notifications to fetch. If unspecified, all notifications will be fetched. */
notificationIds?: string[]
}Response
{
/** If successful. One of "result" and "error" will be present. */
result?: {
notifications: {
id: string,
timestamp: number,
viewed: boolean,
data: {
type: 'accountRegistered'
} | {
type: 'trainingFinished',
modelId: string,
trainingSessionId: string,
newStateName: string,
state: 'failed' | 'completed'
} | {
type: 'alert',
subject: string,
message: string,
fix?: {
name: string,
url: string
}
}
}[]
},
/** If failed */
error?: {
code: 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
} | {
code: 'invalid_parameter',
parameterName: string,
reason: string
}
}Example
Following the installation guide to setup the Decthings API for TypeScript. Add your parameters to the following code and run it in Node.js, or in a browser by using a bundler.
The code reads your API key from file. Create an API key and save it to the file "auth.txt". Keep your key safe!
import * as fs from 'fs'
import { DecthingsClient } from '@decthings/api-client'
let apiKey = fs.readFileSync('./auth.txt').toString().trim()
let client = new DecthingsClient({ apiKey })
async function main() {
try {
let response = await client.user.getNotifications()
if (result.error) {
// Decthings sent us an error
console.log(response.error)
} else {
// Success!
console.log(response.result)
}
}
catch (e) {
// Client throws an error on connection issues. The function may or may not have succeded
console.log(e)
}
}
main()