Returns a paginated list of simulation scenarios for the authenticated project.
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const simulationScenarios = await client.simulationScenario.list();
console.log(simulationScenarios.data);{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"steps": [
{
"nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "START",
"content": "<string>",
"linkedScenarioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtmfDigits": "<string>",
"silenceDurationSeconds": 123
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"pagination": {
"total": 123,
"hasMore": true,
"nextCursor": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
import Roark from '@roarkanalytics/sdk';
const client = new Roark({
bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});
const simulationScenarios = await client.simulationScenario.list();
console.log(simulationScenarios.data);{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"steps": [
{
"nodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "START",
"content": "<string>",
"linkedScenarioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dtmfDigits": "<string>",
"silenceDurationSeconds": 123
}
],
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"pagination": {
"total": 123,
"hasMore": true,
"nextCursor": "<string>"
}
}