@roarkanalytics/sdk 3.14.0 → 3.16.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 (37) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/package.json +1 -1
  3. package/resources/config.d.mts +47 -6
  4. package/resources/config.d.mts.map +1 -1
  5. package/resources/config.d.ts +47 -6
  6. package/resources/config.d.ts.map +1 -1
  7. package/resources/customer-flow-edge-case.d.mts +384 -3
  8. package/resources/customer-flow-edge-case.d.mts.map +1 -1
  9. package/resources/customer-flow-edge-case.d.ts +384 -3
  10. package/resources/customer-flow-edge-case.d.ts.map +1 -1
  11. package/resources/customer-flow.d.mts +1576 -39
  12. package/resources/customer-flow.d.mts.map +1 -1
  13. package/resources/customer-flow.d.ts +1576 -39
  14. package/resources/customer-flow.d.ts.map +1 -1
  15. package/resources/http-request-definition.d.mts +24 -0
  16. package/resources/http-request-definition.d.mts.map +1 -1
  17. package/resources/http-request-definition.d.ts +24 -0
  18. package/resources/http-request-definition.d.ts.map +1 -1
  19. package/resources/simulation-run-plan.d.mts +44 -0
  20. package/resources/simulation-run-plan.d.mts.map +1 -1
  21. package/resources/simulation-run-plan.d.ts +44 -0
  22. package/resources/simulation-run-plan.d.ts.map +1 -1
  23. package/resources/simulation.d.mts +14 -0
  24. package/resources/simulation.d.mts.map +1 -1
  25. package/resources/simulation.d.ts +14 -0
  26. package/resources/simulation.d.ts.map +1 -1
  27. package/src/resources/config.ts +87 -3
  28. package/src/resources/customer-flow-edge-case.ts +909 -204
  29. package/src/resources/customer-flow.ts +4334 -1494
  30. package/src/resources/http-request-definition.ts +28 -0
  31. package/src/resources/simulation-run-plan.ts +50 -0
  32. package/src/resources/simulation.ts +15 -0
  33. package/src/version.ts +1 -1
  34. package/version.d.mts +1 -1
  35. package/version.d.ts +1 -1
  36. package/version.js +1 -1
  37. package/version.mjs +1 -1
@@ -113,6 +113,13 @@ export namespace HTTPRequestDefinitionCreateResponse {
113
113
  */
114
114
  headers: { [key: string]: string };
115
115
 
116
+ /**
117
+ * Whether this definition is managed by config-as-code. A managed definition is
118
+ * reconciled from your config: PUT returns 409, and changes belong in the config
119
+ * file (or detach it first).
120
+ */
121
+ isConfigManaged: boolean;
122
+
116
123
  /**
117
124
  * HTTP method: POST, PUT, PATCH, or GET
118
125
  */
@@ -182,6 +189,13 @@ export namespace HTTPRequestDefinitionUpdateResponse {
182
189
  */
183
190
  headers: { [key: string]: string };
184
191
 
192
+ /**
193
+ * Whether this definition is managed by config-as-code. A managed definition is
194
+ * reconciled from your config: PUT returns 409, and changes belong in the config
195
+ * file (or detach it first).
196
+ */
197
+ isConfigManaged: boolean;
198
+
185
199
  /**
186
200
  * HTTP method: POST, PUT, PATCH, or GET
187
201
  */
@@ -245,6 +259,13 @@ export namespace HTTPRequestDefinitionListResponse {
245
259
  */
246
260
  headers: { [key: string]: string };
247
261
 
262
+ /**
263
+ * Whether this definition is managed by config-as-code. A managed definition is
264
+ * reconciled from your config: PUT returns 409, and changes belong in the config
265
+ * file (or detach it first).
266
+ */
267
+ isConfigManaged: boolean;
268
+
248
269
  /**
249
270
  * HTTP method: POST, PUT, PATCH, or GET
250
271
  */
@@ -326,6 +347,13 @@ export namespace HTTPRequestDefinitionGetByIDResponse {
326
347
  */
327
348
  headers: { [key: string]: string };
328
349
 
350
+ /**
351
+ * Whether this definition is managed by config-as-code. A managed definition is
352
+ * reconciled from your config: PUT returns 409, and changes belong in the config
353
+ * file (or detach it first).
354
+ */
355
+ isConfigManaged: boolean;
356
+
329
357
  /**
330
358
  * HTTP method: POST, PUT, PATCH, or GET
331
359
  */
@@ -228,6 +228,13 @@ export namespace SimulationRunPlanCreateResponse {
228
228
  */
229
229
  personas: Array<RunPlan.Persona>;
230
230
 
231
+ /**
232
+ * The flow variant this plan's runs are measured against: the run report shows
233
+ * every other flow variant in the run as a difference from it. `null` means the
234
+ * plan declares no experiment.
235
+ */
236
+ referenceCustomerFlowVariantId: string | null;
237
+
231
238
  /**
232
239
  * @deprecated Deprecated: use `flows` instead. Scenarios included in this run
233
240
  * plan.
@@ -516,6 +523,13 @@ export namespace SimulationRunPlanUpdateResponse {
516
523
  */
517
524
  personas: Array<Data.Persona>;
518
525
 
526
+ /**
527
+ * The flow variant this plan's runs are measured against: the run report shows
528
+ * every other flow variant in the run as a difference from it. `null` means the
529
+ * plan declares no experiment.
530
+ */
531
+ referenceCustomerFlowVariantId: string | null;
532
+
519
533
  /**
520
534
  * @deprecated Deprecated: use `flows` instead. Scenarios included in this run
521
535
  * plan.
@@ -768,6 +782,13 @@ export namespace SimulationRunPlanListResponse {
768
782
  */
769
783
  personas: Array<Data.Persona>;
770
784
 
785
+ /**
786
+ * The flow variant this plan's runs are measured against: the run report shows
787
+ * every other flow variant in the run as a difference from it. `null` means the
788
+ * plan declares no experiment.
789
+ */
790
+ referenceCustomerFlowVariantId: string | null;
791
+
771
792
  /**
772
793
  * @deprecated Deprecated: use `flows` instead. Scenarios included in this run
773
794
  * plan.
@@ -1048,6 +1069,13 @@ export namespace SimulationRunPlanGetByIDResponse {
1048
1069
  */
1049
1070
  personas: Array<Data.Persona>;
1050
1071
 
1072
+ /**
1073
+ * The flow variant this plan's runs are measured against: the run report shows
1074
+ * every other flow variant in the run as a difference from it. `null` means the
1075
+ * plan declares no experiment.
1076
+ */
1077
+ referenceCustomerFlowVariantId: string | null;
1078
+
1051
1079
  /**
1052
1080
  * @deprecated Deprecated: use `flows` instead. Scenarios included in this run
1053
1081
  * plan.
@@ -1309,6 +1337,21 @@ export interface SimulationRunPlanCreateParams {
1309
1337
  */
1310
1338
  personas?: Array<SimulationRunPlanCreateParams.Persona>;
1311
1339
 
1340
+ /**
1341
+ * Name one flow variant as this run plan's REFERENCE arm.
1342
+ *
1343
+ * Every other flow variant the plan runs is then reported as a difference from
1344
+ * this one, which is how a run answers "what did the change cost" rather than just
1345
+ * "what did it score". The usual shape is one flow whose default variant is the
1346
+ * control (say, a silent environment) plus one edge-case variant per condition
1347
+ * under test.
1348
+ *
1349
+ * The variant must be one this plan actually runs: it has to belong to a flow in
1350
+ * `flows`, and that flow's variant selection has to resolve to it. Omit or set
1351
+ * null for a plan that is a general health check rather than an experiment.
1352
+ */
1353
+ referenceCustomerFlowVariantId?: string | null;
1354
+
1312
1355
  /**
1313
1356
  * @deprecated Deprecated: use `flows` instead. Scenarios to include in this run
1314
1357
  * plan. The same scenario ID can appear multiple times with different variables.
@@ -1551,6 +1594,13 @@ export interface SimulationRunPlanUpdateParams {
1551
1594
  */
1552
1595
  personas?: Array<SimulationRunPlanUpdateParams.Persona>;
1553
1596
 
1597
+ /**
1598
+ * The reference arm every other flow variant in a run is reported as a difference
1599
+ * from. Send `null` to clear it; omit the field to leave it unchanged. See
1600
+ * `POST /v1/simulation/plan`.
1601
+ */
1602
+ referenceCustomerFlowVariantId?: string | null;
1603
+
1554
1604
  /**
1555
1605
  * @deprecated Deprecated: use `flows` instead. Replaces the scenarios on this run
1556
1606
  * plan. Omit to leave them unchanged; send an empty array to detach them all,
@@ -271,6 +271,21 @@ export declare namespace SimulationRunParams {
271
271
  */
272
272
  personas?: Array<Plan.Persona>;
273
273
 
274
+ /**
275
+ * Name one flow variant as this run plan's REFERENCE arm.
276
+ *
277
+ * Every other flow variant the plan runs is then reported as a difference from
278
+ * this one, which is how a run answers "what did the change cost" rather than just
279
+ * "what did it score". The usual shape is one flow whose default variant is the
280
+ * control (say, a silent environment) plus one edge-case variant per condition
281
+ * under test.
282
+ *
283
+ * The variant must be one this plan actually runs: it has to belong to a flow in
284
+ * `flows`, and that flow's variant selection has to resolve to it. Omit or set
285
+ * null for a plan that is a general health check rather than an experiment.
286
+ */
287
+ referenceCustomerFlowVariantId?: string | null;
288
+
274
289
  /**
275
290
  * @deprecated Deprecated: use `flows` instead. Scenarios to include in this run
276
291
  * plan. The same scenario ID can appear multiple times with different variables.
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '3.14.0'; // x-release-please-version
1
+ export const VERSION = '3.16.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "3.14.0";
1
+ export declare const VERSION = "3.16.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "3.14.0";
1
+ export declare const VERSION = "3.16.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '3.14.0'; // x-release-please-version
4
+ exports.VERSION = '3.16.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '3.14.0'; // x-release-please-version
1
+ export const VERSION = '3.16.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map