@roarkanalytics/sdk 3.8.0 → 3.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/client.d.mts +3 -0
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +3 -0
  5. package/client.d.ts.map +1 -1
  6. package/client.js +3 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +3 -0
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/config.d.mts +131 -5
  12. package/resources/config.d.mts.map +1 -1
  13. package/resources/config.d.ts +131 -5
  14. package/resources/config.d.ts.map +1 -1
  15. package/resources/customer-flow-edge-case.d.mts +9 -0
  16. package/resources/customer-flow-edge-case.d.mts.map +1 -1
  17. package/resources/customer-flow-edge-case.d.ts +9 -0
  18. package/resources/customer-flow-edge-case.d.ts.map +1 -1
  19. package/resources/customer-flow.d.mts +30 -0
  20. package/resources/customer-flow.d.mts.map +1 -1
  21. package/resources/customer-flow.d.ts +30 -0
  22. package/resources/customer-flow.d.ts.map +1 -1
  23. package/resources/index.d.mts +1 -0
  24. package/resources/index.d.mts.map +1 -1
  25. package/resources/index.d.ts +1 -0
  26. package/resources/index.d.ts.map +1 -1
  27. package/resources/index.js +3 -1
  28. package/resources/index.js.map +1 -1
  29. package/resources/index.mjs +1 -0
  30. package/resources/index.mjs.map +1 -1
  31. package/resources/simulation-run-plan.d.mts +38 -0
  32. package/resources/simulation-run-plan.d.mts.map +1 -1
  33. package/resources/simulation-run-plan.d.ts +38 -0
  34. package/resources/simulation-run-plan.d.ts.map +1 -1
  35. package/resources/simulation-template.d.mts +162 -0
  36. package/resources/simulation-template.d.mts.map +1 -0
  37. package/resources/simulation-template.d.ts +162 -0
  38. package/resources/simulation-template.d.ts.map +1 -0
  39. package/resources/simulation-template.js +31 -0
  40. package/resources/simulation-template.js.map +1 -0
  41. package/resources/simulation-template.mjs +27 -0
  42. package/resources/simulation-template.mjs.map +1 -0
  43. package/resources/simulation.d.mts +13 -0
  44. package/resources/simulation.d.mts.map +1 -1
  45. package/resources/simulation.d.ts +13 -0
  46. package/resources/simulation.d.ts.map +1 -1
  47. package/src/client.ts +8 -0
  48. package/src/resources/config.ts +272 -2
  49. package/src/resources/customer-flow-edge-case.ts +18 -0
  50. package/src/resources/customer-flow.ts +60 -0
  51. package/src/resources/index.ts +1 -0
  52. package/src/resources/simulation-run-plan.ts +44 -0
  53. package/src/resources/simulation-template.ts +190 -0
  54. package/src/resources/simulation.ts +14 -0
  55. package/src/version.ts +1 -1
  56. package/version.d.mts +1 -1
  57. package/version.d.mts.map +1 -1
  58. package/version.d.ts +1 -1
  59. package/version.d.ts.map +1 -1
  60. package/version.js +1 -1
  61. package/version.js.map +1 -1
  62. package/version.mjs +1 -1
  63. package/version.mjs.map +1 -1
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.SimulationTemplate = void 0;
5
+ const resource_1 = require("../core/resource.js");
6
+ class SimulationTemplate extends resource_1.APIResource {
7
+ /**
8
+ * Returns the built-in simulation templates, each resolved against this project:
9
+ * the metric and check definitions it collects, and the flows it runs with the
10
+ * variants it covers.
11
+ *
12
+ * A template is a preset rather than a stored object, so building a run from one
13
+ * produces an ordinary run plan you own and can edit afterwards. Pass a `slug` as
14
+ * `template` to POST /v1/simulation/run.
15
+ *
16
+ * Every entry is complete, so there is no per-template endpoint to follow up with,
17
+ * and the list is a fixed catalogue rather than a paginated one. Only templates a
18
+ * request can actually run are listed.
19
+ *
20
+ * @example
21
+ * ```ts
22
+ * const simulationTemplates =
23
+ * await client.simulationTemplate.list();
24
+ * ```
25
+ */
26
+ list(options) {
27
+ return this._client.get('/v1/simulation/template', options);
28
+ }
29
+ }
30
+ exports.SimulationTemplate = SimulationTemplate;
31
+ //# sourceMappingURL=simulation-template.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"simulation-template.js","sourceRoot":"","sources":["../src/resources/simulation-template.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,kBAAmB,SAAQ,sBAAW;IACjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF;AAvBD,gDAuBC"}
@@ -0,0 +1,27 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../core/resource.mjs";
3
+ export class SimulationTemplate extends APIResource {
4
+ /**
5
+ * Returns the built-in simulation templates, each resolved against this project:
6
+ * the metric and check definitions it collects, and the flows it runs with the
7
+ * variants it covers.
8
+ *
9
+ * A template is a preset rather than a stored object, so building a run from one
10
+ * produces an ordinary run plan you own and can edit afterwards. Pass a `slug` as
11
+ * `template` to POST /v1/simulation/run.
12
+ *
13
+ * Every entry is complete, so there is no per-template endpoint to follow up with,
14
+ * and the list is a fixed catalogue rather than a paginated one. Only templates a
15
+ * request can actually run are listed.
16
+ *
17
+ * @example
18
+ * ```ts
19
+ * const simulationTemplates =
20
+ * await client.simulationTemplate.list();
21
+ * ```
22
+ */
23
+ list(options) {
24
+ return this._client.get('/v1/simulation/template', options);
25
+ }
26
+ }
27
+ //# sourceMappingURL=simulation-template.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"simulation-template.mjs","sourceRoot":"","sources":["../src/resources/simulation-template.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD;;;;;;;;;;;;;;;;;;OAkBG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;CACF"}
@@ -169,6 +169,19 @@ export declare namespace SimulationRunParams {
169
169
  * once with a different persona override or different variables.
170
170
  */
171
171
  flows?: Array<Plan.Flow>;
172
+ /**
173
+ * Also collect each attached flow's own metrics, on top of the `metrics` named
174
+ * here.
175
+ *
176
+ * Default true, which is what you want when you brought your own flows and their
177
+ * graders. Set false for a run whose metric list is meant to be exhaustive: a
178
+ * template like Load Testing or Voicemail deliberately grades a narrow set, and
179
+ * inheriting every flow metric on top multiplies analysis cost across the volume
180
+ * without adding signal.
181
+ *
182
+ * GET /v1/simulation/template returns the value each template expects.
183
+ */
184
+ includeFlowMetrics?: boolean;
172
185
  /**
173
186
  * Number of iterations to run for each test case (1-10000)
174
187
  */
@@ -1 +1 @@
1
- {"version":3,"file":"simulation.d.mts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
1
+ {"version":3,"file":"simulation.d.mts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;;;;;;;;;;eAWG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
@@ -169,6 +169,19 @@ export declare namespace SimulationRunParams {
169
169
  * once with a different persona override or different variables.
170
170
  */
171
171
  flows?: Array<Plan.Flow>;
172
+ /**
173
+ * Also collect each attached flow's own metrics, on top of the `metrics` named
174
+ * here.
175
+ *
176
+ * Default true, which is what you want when you brought your own flows and their
177
+ * graders. Set false for a run whose metric list is meant to be exhaustive: a
178
+ * template like Load Testing or Voicemail deliberately grades a narrow set, and
179
+ * inheriting every flow metric on top multiplies analysis cost across the volume
180
+ * without adding signal.
181
+ *
182
+ * GET /v1/simulation/template returns the value each template expects.
183
+ */
184
+ includeFlowMetrics?: boolean;
172
185
  /**
173
186
  * Number of iterations to run for each test case (1-10000)
174
187
  */
@@ -1 +1 @@
1
- {"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
1
+ {"version":3,"file":"simulation.d.ts","sourceRoot":"","sources":["../src/resources/simulation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,UAAW,SAAQ,WAAW;IACzC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAG5F;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,qBAAqB,CAAC,IAAI,CAAC;CAClC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,WAAW,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,kBAAkB,EAAE,MAAM,CAAC;QAE3B;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;WAEG;QACH,sBAAsB,EAAE,MAAM,CAAC;QAE/B;;;WAGG;QACH,MAAM,EACF,SAAS,GACT,QAAQ,GACR,oBAAoB,GACpB,sBAAsB,GACtB,oBAAoB,GACpB,qBAAqB,GACrB,WAAW,GACX,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,GACZ,oBAAoB,CAAC;KAC1B;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,uBAAuB,GAC3C,mBAAmB,CAAC,uBAAuB,CAAC;AAEhD,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC;QAEnC;;;;;;;WAOG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,cAAc,EAAE,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YAE1C;;eAEG;YACH,SAAS,EAAE,SAAS,GAAG,UAAU,CAAC;YAElC;;eAEG;YACH,4BAA4B,EAAE,MAAM,CAAC;YAErC;;;eAGG;YACH,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAE5B;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;eAGG;YACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;YAE/B;;;;;;;;;;;;;eAaG;YACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;YAErC;;eAEG;YACH,aAAa,CAAC,EAAE,UAAU,GAAG,0BAA0B,GAAG,oBAAoB,CAAC;YAE/E;;;eAGG;YACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAEzB;;;;;;;;;;;eAWG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;YAE7B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YAExB;;eAEG;YACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAE3B;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/B;;;eAGG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAEjC;;eAEG;YACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;SAChC;QAED,UAAiB,IAAI,CAAC;YACpB,UAAiB,aAAa;gBAC5B,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,MAAM;gBACrB;;mBAEG;gBACH,EAAE,CAAC,EAAE,MAAM,CAAC;gBAEZ;;;;;;;;;mBASG;gBACH,kBAAkB,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,IAAI,CAAC;gBAEjD;;;mBAGG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;;mBAGG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;YAED;;;;;;eAMG;YACH,UAAiB,IAAI;gBACnB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;;mBAIG;gBACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAE7C;;mBAEG;gBACH,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEpB;;mBAEG;gBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAElC;;mBAEG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;YAED,UAAiB,IAAI,CAAC;gBACpB,UAAiB,YAAY;oBAC3B;;uBAEG;oBACH,EAAE,EAAE,MAAM,CAAC;oBAEX;;uBAEG;oBACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;oBAElC;;uBAEG;oBACH,SAAS,CAAC,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;iBACvC;aACF;YAED,UAAiB,OAAO;gBACtB,EAAE,EAAE,MAAM,CAAC;aACZ;YAED,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX;;;mBAGG;gBACH,SAAS,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACvC;SACF;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;IAED,UAAiB,uBAAuB;QACtC;;;WAGG;QACH,MAAM,EAAE,MAAM,CAAC;QAEf;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,SAAS,CAAC,EACN;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,GACzB,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,GAC3C,KAAK,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC;KACjD;IAED,UAAiB,uBAAuB,CAAC;QACvC,UAAiB,YAAY;YAC3B;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;YAErC;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;eAEG;YACH,SAAS,CAAC,EAAE,IAAI,CAAC;SAClB;QAED,UAAiB,YAAY;YAC3B;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,SAAS,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;aAAE,CAAC;SACtC;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,UAAU,CAAC;IAClC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
package/src/client.ts CHANGED
@@ -181,6 +181,7 @@ import {
181
181
  SimulationRunPlanJobStartParams,
182
182
  SimulationRunPlanJobStartResponse,
183
183
  } from './resources/simulation-run-plan-job';
184
+ import { SimulationTemplate, SimulationTemplateListResponse } from './resources/simulation-template';
184
185
  import {
185
186
  Webhook,
186
187
  WebhookCreateParams,
@@ -919,6 +920,7 @@ export class Roark {
919
920
  simulationRunPlanJob: API.SimulationRunPlanJob = new API.SimulationRunPlanJob(this);
920
921
  simulationPersona: API.SimulationPersona = new API.SimulationPersona(this);
921
922
  simulationEnvironment: API.SimulationEnvironment = new API.SimulationEnvironment(this);
923
+ simulationTemplate: API.SimulationTemplate = new API.SimulationTemplate(this);
922
924
  customerFlow: API.CustomerFlow = new API.CustomerFlow(this);
923
925
  customerFlowEdgeCase: API.CustomerFlowEdgeCase = new API.CustomerFlowEdgeCase(this);
924
926
  agent: API.Agent = new API.Agent(this);
@@ -940,6 +942,7 @@ Roark.SimulationRunPlan = SimulationRunPlan;
940
942
  Roark.SimulationRunPlanJob = SimulationRunPlanJob;
941
943
  Roark.SimulationPersona = SimulationPersona;
942
944
  Roark.SimulationEnvironment = SimulationEnvironment;
945
+ Roark.SimulationTemplate = SimulationTemplate;
943
946
  Roark.CustomerFlow = CustomerFlow;
944
947
  Roark.CustomerFlowEdgeCase = CustomerFlowEdgeCase;
945
948
  Roark.Agent = Agent;
@@ -1065,6 +1068,11 @@ export declare namespace Roark {
1065
1068
  type SimulationEnvironmentListParams as SimulationEnvironmentListParams,
1066
1069
  };
1067
1070
 
1071
+ export {
1072
+ SimulationTemplate as SimulationTemplate,
1073
+ type SimulationTemplateListResponse as SimulationTemplateListResponse,
1074
+ };
1075
+
1068
1076
  export {
1069
1077
  CustomerFlow as CustomerFlow,
1070
1078
  type FlowStep as FlowStep,
@@ -49,6 +49,7 @@ export interface Bundle {
49
49
  | Bundle.ScriptedFlowConfig
50
50
  | Bundle.CollectorConfig
51
51
  | Bundle.MetricConfig
52
+ | Bundle.AlertConfig
52
53
  >;
53
54
 
54
55
  prune?: boolean;
@@ -362,6 +363,95 @@ export namespace Bundle {
362
363
  description?: string;
363
364
  }
364
365
  }
366
+
367
+ export interface AlertConfig {
368
+ kind: 'alert';
369
+
370
+ name: string;
371
+
372
+ trigger:
373
+ | AlertConfig.AlertThresholdTrigger
374
+ | AlertConfig.AlertEventTrigger
375
+ | AlertConfig.AlertSimulationTrigger;
376
+
377
+ actions?: AlertConfig.Actions;
378
+
379
+ enabled?: boolean;
380
+ }
381
+
382
+ export namespace AlertConfig {
383
+ export interface AlertThresholdTrigger {
384
+ aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
385
+
386
+ metric: string;
387
+
388
+ operator: 'GT' | 'GTE' | 'LT' | 'LTE';
389
+
390
+ thresholdValue: number;
391
+
392
+ type: 'threshold';
393
+
394
+ windowMinutes: number;
395
+
396
+ consecutiveOpen?: number;
397
+
398
+ consecutiveResolve?: number;
399
+
400
+ grouping?: 'NONE' | 'BY_AGENT';
401
+
402
+ metricVariant?: string;
403
+
404
+ minSampleSize?: number;
405
+ }
406
+
407
+ export interface AlertEventTrigger {
408
+ events: Array<
409
+ | 'CALL_ANALYSIS_COMPLETED'
410
+ | 'CALL_ANALYSIS_FAILED'
411
+ | 'CALL_ANALYSIS_CANCELLED'
412
+ | 'SIMULATION_RUN_PLAN_JOB_STARTED'
413
+ | 'SIMULATION_RUN_PLAN_JOB_COMPLETED'
414
+ | 'SIMULATION_RUN_PLAN_JOB_FAILED'
415
+ | 'SIMULATION_RUN_PLAN_JOB_CANCELLED'
416
+ | 'SIMULATION_JOB_STARTED'
417
+ | 'SIMULATION_JOB_COMPLETED'
418
+ | 'SIMULATION_JOB_FAILED'
419
+ | 'SIMULATION_JOB_CANCELLED'
420
+ | 'METRIC_COLLECTION_JOB_COMPLETED'
421
+ | 'METRIC_COLLECTION_JOB_FAILED'
422
+ | 'CHAT_ANALYSIS_COMPLETED'
423
+ | 'CHAT_ANALYSIS_FAILED'
424
+ | 'ISSUE_OPENED'
425
+ | 'ISSUE_RESOLVED'
426
+ >;
427
+
428
+ type: 'event';
429
+ }
430
+
431
+ export interface AlertSimulationTrigger {
432
+ conditions: Array<'SUCCESS' | 'FAILURE' | 'THRESHOLD_FAILED'>;
433
+
434
+ type: 'simulation';
435
+
436
+ deliveryFormat?: 'MESSAGE' | 'PDF';
437
+
438
+ runPlan?: string;
439
+ }
440
+
441
+ export interface Actions {
442
+ slack?: Array<Actions.Slack>;
443
+
444
+ webhooks?: Array<string>;
445
+ }
446
+
447
+ export namespace Actions {
448
+ export interface Slack {
449
+ channelId: string;
450
+
451
+ channelName: string;
452
+ }
453
+ }
454
+ }
365
455
  }
366
456
 
367
457
  export interface ConfigFlowStep {
@@ -405,7 +495,7 @@ export namespace ConfigApplyResponse {
405
495
  export interface Change {
406
496
  configKey: string;
407
497
 
408
- kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric';
498
+ kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'alert';
409
499
 
410
500
  name: string;
411
501
 
@@ -449,7 +539,7 @@ export namespace ConfigDiffResponse {
449
539
  export interface Change {
450
540
  configKey: string;
451
541
 
452
- kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric';
542
+ kind: 'agent' | 'persona' | 'flow' | 'collector' | 'metric' | 'alert';
453
543
 
454
544
  name: string;
455
545
 
@@ -478,6 +568,7 @@ export interface ConfigApplyParams {
478
568
  | ConfigApplyParams.ScriptedFlowConfig
479
569
  | ConfigApplyParams.CollectorConfig
480
570
  | ConfigApplyParams.MetricConfig
571
+ | ConfigApplyParams.AlertConfig
481
572
  >;
482
573
 
483
574
  prune?: boolean;
@@ -791,6 +882,95 @@ export namespace ConfigApplyParams {
791
882
  description?: string;
792
883
  }
793
884
  }
885
+
886
+ export interface AlertConfig {
887
+ kind: 'alert';
888
+
889
+ name: string;
890
+
891
+ trigger:
892
+ | AlertConfig.AlertThresholdTrigger
893
+ | AlertConfig.AlertEventTrigger
894
+ | AlertConfig.AlertSimulationTrigger;
895
+
896
+ actions?: AlertConfig.Actions;
897
+
898
+ enabled?: boolean;
899
+ }
900
+
901
+ export namespace AlertConfig {
902
+ export interface AlertThresholdTrigger {
903
+ aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
904
+
905
+ metric: string;
906
+
907
+ operator: 'GT' | 'GTE' | 'LT' | 'LTE';
908
+
909
+ thresholdValue: number;
910
+
911
+ type: 'threshold';
912
+
913
+ windowMinutes: number;
914
+
915
+ consecutiveOpen?: number;
916
+
917
+ consecutiveResolve?: number;
918
+
919
+ grouping?: 'NONE' | 'BY_AGENT';
920
+
921
+ metricVariant?: string;
922
+
923
+ minSampleSize?: number;
924
+ }
925
+
926
+ export interface AlertEventTrigger {
927
+ events: Array<
928
+ | 'CALL_ANALYSIS_COMPLETED'
929
+ | 'CALL_ANALYSIS_FAILED'
930
+ | 'CALL_ANALYSIS_CANCELLED'
931
+ | 'SIMULATION_RUN_PLAN_JOB_STARTED'
932
+ | 'SIMULATION_RUN_PLAN_JOB_COMPLETED'
933
+ | 'SIMULATION_RUN_PLAN_JOB_FAILED'
934
+ | 'SIMULATION_RUN_PLAN_JOB_CANCELLED'
935
+ | 'SIMULATION_JOB_STARTED'
936
+ | 'SIMULATION_JOB_COMPLETED'
937
+ | 'SIMULATION_JOB_FAILED'
938
+ | 'SIMULATION_JOB_CANCELLED'
939
+ | 'METRIC_COLLECTION_JOB_COMPLETED'
940
+ | 'METRIC_COLLECTION_JOB_FAILED'
941
+ | 'CHAT_ANALYSIS_COMPLETED'
942
+ | 'CHAT_ANALYSIS_FAILED'
943
+ | 'ISSUE_OPENED'
944
+ | 'ISSUE_RESOLVED'
945
+ >;
946
+
947
+ type: 'event';
948
+ }
949
+
950
+ export interface AlertSimulationTrigger {
951
+ conditions: Array<'SUCCESS' | 'FAILURE' | 'THRESHOLD_FAILED'>;
952
+
953
+ type: 'simulation';
954
+
955
+ deliveryFormat?: 'MESSAGE' | 'PDF';
956
+
957
+ runPlan?: string;
958
+ }
959
+
960
+ export interface Actions {
961
+ slack?: Array<Actions.Slack>;
962
+
963
+ webhooks?: Array<string>;
964
+ }
965
+
966
+ export namespace Actions {
967
+ export interface Slack {
968
+ channelId: string;
969
+
970
+ channelName: string;
971
+ }
972
+ }
973
+ }
794
974
  }
795
975
 
796
976
  export interface ConfigDiffParams {
@@ -801,6 +981,7 @@ export interface ConfigDiffParams {
801
981
  | ConfigDiffParams.ScriptedFlowConfig
802
982
  | ConfigDiffParams.CollectorConfig
803
983
  | ConfigDiffParams.MetricConfig
984
+ | ConfigDiffParams.AlertConfig
804
985
  >;
805
986
 
806
987
  prune?: boolean;
@@ -1114,6 +1295,95 @@ export namespace ConfigDiffParams {
1114
1295
  description?: string;
1115
1296
  }
1116
1297
  }
1298
+
1299
+ export interface AlertConfig {
1300
+ kind: 'alert';
1301
+
1302
+ name: string;
1303
+
1304
+ trigger:
1305
+ | AlertConfig.AlertThresholdTrigger
1306
+ | AlertConfig.AlertEventTrigger
1307
+ | AlertConfig.AlertSimulationTrigger;
1308
+
1309
+ actions?: AlertConfig.Actions;
1310
+
1311
+ enabled?: boolean;
1312
+ }
1313
+
1314
+ export namespace AlertConfig {
1315
+ export interface AlertThresholdTrigger {
1316
+ aggregation: 'COUNT' | 'RATE_PER_MINUTE' | 'MEAN';
1317
+
1318
+ metric: string;
1319
+
1320
+ operator: 'GT' | 'GTE' | 'LT' | 'LTE';
1321
+
1322
+ thresholdValue: number;
1323
+
1324
+ type: 'threshold';
1325
+
1326
+ windowMinutes: number;
1327
+
1328
+ consecutiveOpen?: number;
1329
+
1330
+ consecutiveResolve?: number;
1331
+
1332
+ grouping?: 'NONE' | 'BY_AGENT';
1333
+
1334
+ metricVariant?: string;
1335
+
1336
+ minSampleSize?: number;
1337
+ }
1338
+
1339
+ export interface AlertEventTrigger {
1340
+ events: Array<
1341
+ | 'CALL_ANALYSIS_COMPLETED'
1342
+ | 'CALL_ANALYSIS_FAILED'
1343
+ | 'CALL_ANALYSIS_CANCELLED'
1344
+ | 'SIMULATION_RUN_PLAN_JOB_STARTED'
1345
+ | 'SIMULATION_RUN_PLAN_JOB_COMPLETED'
1346
+ | 'SIMULATION_RUN_PLAN_JOB_FAILED'
1347
+ | 'SIMULATION_RUN_PLAN_JOB_CANCELLED'
1348
+ | 'SIMULATION_JOB_STARTED'
1349
+ | 'SIMULATION_JOB_COMPLETED'
1350
+ | 'SIMULATION_JOB_FAILED'
1351
+ | 'SIMULATION_JOB_CANCELLED'
1352
+ | 'METRIC_COLLECTION_JOB_COMPLETED'
1353
+ | 'METRIC_COLLECTION_JOB_FAILED'
1354
+ | 'CHAT_ANALYSIS_COMPLETED'
1355
+ | 'CHAT_ANALYSIS_FAILED'
1356
+ | 'ISSUE_OPENED'
1357
+ | 'ISSUE_RESOLVED'
1358
+ >;
1359
+
1360
+ type: 'event';
1361
+ }
1362
+
1363
+ export interface AlertSimulationTrigger {
1364
+ conditions: Array<'SUCCESS' | 'FAILURE' | 'THRESHOLD_FAILED'>;
1365
+
1366
+ type: 'simulation';
1367
+
1368
+ deliveryFormat?: 'MESSAGE' | 'PDF';
1369
+
1370
+ runPlan?: string;
1371
+ }
1372
+
1373
+ export interface Actions {
1374
+ slack?: Array<Actions.Slack>;
1375
+
1376
+ webhooks?: Array<string>;
1377
+ }
1378
+
1379
+ export namespace Actions {
1380
+ export interface Slack {
1381
+ channelId: string;
1382
+
1383
+ channelName: string;
1384
+ }
1385
+ }
1386
+ }
1117
1387
  }
1118
1388
 
1119
1389
  export declare namespace Config {
@@ -162,6 +162,8 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
162
162
  * Last update timestamp in ISO 8601 format
163
163
  */
164
164
  updatedAt: string;
165
+
166
+ systemKey?: string | null;
165
167
  }
166
168
 
167
169
  export namespace ScriptedFlowVariant {
@@ -466,6 +468,8 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
466
468
  * The brief the simulated customer improvises from.
467
469
  */
468
470
  prompt?: string | null;
471
+
472
+ systemKey?: string | null;
469
473
  }
470
474
 
471
475
  export namespace ImprovFlowVariant {
@@ -765,6 +769,8 @@ export namespace CustomerFlowEdgeCaseUpdateResponse {
765
769
  * Last update timestamp in ISO 8601 format
766
770
  */
767
771
  updatedAt: string;
772
+
773
+ systemKey?: string | null;
768
774
  }
769
775
 
770
776
  export namespace VoicemailFlowVariant {
@@ -1083,6 +1089,8 @@ export namespace CustomerFlowEdgeCaseAddResponse {
1083
1089
  * Last update timestamp in ISO 8601 format
1084
1090
  */
1085
1091
  updatedAt: string;
1092
+
1093
+ systemKey?: string | null;
1086
1094
  }
1087
1095
 
1088
1096
  export namespace ScriptedFlowVariant {
@@ -1387,6 +1395,8 @@ export namespace CustomerFlowEdgeCaseAddResponse {
1387
1395
  * The brief the simulated customer improvises from.
1388
1396
  */
1389
1397
  prompt?: string | null;
1398
+
1399
+ systemKey?: string | null;
1390
1400
  }
1391
1401
 
1392
1402
  export namespace ImprovFlowVariant {
@@ -1686,6 +1696,8 @@ export namespace CustomerFlowEdgeCaseAddResponse {
1686
1696
  * Last update timestamp in ISO 8601 format
1687
1697
  */
1688
1698
  updatedAt: string;
1699
+
1700
+ systemKey?: string | null;
1689
1701
  }
1690
1702
 
1691
1703
  export namespace VoicemailFlowVariant {
@@ -2004,6 +2016,8 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
2004
2016
  * Last update timestamp in ISO 8601 format
2005
2017
  */
2006
2018
  updatedAt: string;
2019
+
2020
+ systemKey?: string | null;
2007
2021
  }
2008
2022
 
2009
2023
  export namespace ScriptedFlowVariant {
@@ -2308,6 +2322,8 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
2308
2322
  * The brief the simulated customer improvises from.
2309
2323
  */
2310
2324
  prompt?: string | null;
2325
+
2326
+ systemKey?: string | null;
2311
2327
  }
2312
2328
 
2313
2329
  export namespace ImprovFlowVariant {
@@ -2607,6 +2623,8 @@ export namespace CustomerFlowEdgeCasePromoteResponse {
2607
2623
  * Last update timestamp in ISO 8601 format
2608
2624
  */
2609
2625
  updatedAt: string;
2626
+
2627
+ systemKey?: string | null;
2610
2628
  }
2611
2629
 
2612
2630
  export namespace VoicemailFlowVariant {