@uniformdev/context 17.5.1-alpha.105 → 17.5.1-alpha.130

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.
@@ -1,33 +1,209 @@
1
1
  import { p as paths$7 } from './v2-manifest.swagger-200ca5ee.js';
2
2
 
3
+ interface components$6 {
4
+ schemas: {
5
+ EnrichmentCategory: {
6
+ /** @description The maximum visitor score allowed for enrichment keys in this category */
7
+ cap: number;
8
+ };
9
+ PreviewSignal: components$6["schemas"]["Signal"] & {
10
+ /** @description Friendly name of the signal */
11
+ name: string;
12
+ /** @description Description of the signal */
13
+ description?: string;
14
+ };
15
+ Signal: {
16
+ /** @description The signal strength per activation (each time its criteria are true, this score is added) */
17
+ str: number;
18
+ /** @description The maximum visitor score allowed for this signal */
19
+ cap: number;
20
+ /**
21
+ * @description How long the signal's score should persist
22
+ * 's' = current session (expires after a period of inactivity)
23
+ * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
24
+ * 't' = transient (score tracks the current state of the criteria every time scores are updated)
25
+ *
26
+ * @enum {string}
27
+ */
28
+ dur: "s" | "p" | "t";
29
+ crit: components$6["schemas"]["RootSignalCriteriaGroup"];
30
+ };
31
+ RootSignalCriteriaGroup: {
32
+ /**
33
+ * @description Criteria type (Group of other criteria)
34
+ * @enum {string}
35
+ */
36
+ type: "G";
37
+ /**
38
+ * @description The logical operator to apply to the criteria groups
39
+ * & = AND
40
+ * | = OR
41
+ *
42
+ * Default is `&` if unspecified.
43
+ *
44
+ * @default &
45
+ * @enum {string}
46
+ */
47
+ op?: "&" | "|";
48
+ /** @description The criteria clauses that make up this grouping of criteria */
49
+ clauses: (components$6["schemas"]["SignalCriteriaGroup"] | components$6["schemas"]["SignalCriteria"])[];
50
+ };
51
+ SignalCriteriaGroup: {
52
+ /**
53
+ * @description Criteria type (Group of other criteria)
54
+ * @enum {string}
55
+ */
56
+ type: "G";
57
+ /**
58
+ * @description The logical operator to apply to the criteria groups
59
+ * & = AND
60
+ * | = OR
61
+ *
62
+ * Default is `&` if unspecified.
63
+ *
64
+ * @enum {string}
65
+ */
66
+ op?: "&" | "|";
67
+ /** @description The criteria clauses that make up this grouping of criteria */
68
+ clauses: (components$6["schemas"]["SignalCriteriaGroup"] | components$6["schemas"]["SignalCriteria"])[];
69
+ };
70
+ SignalCriteria: components$6["schemas"]["CookieCriteria"] | components$6["schemas"]["QueryStringCriteria"] | components$6["schemas"]["QuirkCriteria"] | components$6["schemas"]["EventCriteria"] | components$6["schemas"]["CurrentPageCriteria"] | components$6["schemas"]["PageViewCountCriteria"];
71
+ /** @description Matches a URL query string parameter value */
72
+ QueryStringCriteria: {
73
+ /** @enum {string} */
74
+ type: "QS";
75
+ /** @description The name of the query string parameter to match */
76
+ queryName: string;
77
+ /** @description The value to match the query string parameter against */
78
+ match: components$6["schemas"]["StringMatch"];
79
+ };
80
+ /** @description Matches a web cookie value */
81
+ CookieCriteria: {
82
+ /** @enum {string} */
83
+ type: "CK";
84
+ /** @description The name of the cookie to match */
85
+ cookieName: string;
86
+ /** @description The value to match the cookie against */
87
+ match: components$6["schemas"]["StringMatch"];
88
+ };
89
+ /** @description Matches a visitor quirk key and value */
90
+ QuirkCriteria: {
91
+ /** @enum {string} */
92
+ type: "QK";
93
+ /** @description The name of the quirk key to match */
94
+ key: string;
95
+ /** @description The quirk value to match against */
96
+ match: components$6["schemas"]["StringMatch"];
97
+ };
98
+ /** @description Matches an analytics event name being fired */
99
+ EventCriteria: {
100
+ /** @enum {string} */
101
+ type: "EVT";
102
+ /** @description How to match the event name */
103
+ event: components$6["schemas"]["StringMatch"];
104
+ };
105
+ /**
106
+ * @description Matches the current page's absolute path (i.e. /path/to/page.html)
107
+ * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
108
+ */
109
+ CurrentPageCriteria: {
110
+ /** @enum {string} */
111
+ type: "PV";
112
+ /** @description The page/route path to match as a page that has been visited */
113
+ path: components$6["schemas"]["StringMatch"];
114
+ };
115
+ PageViewCountCriteria: {
116
+ /** @enum {string} */
117
+ type: "PVC";
118
+ /** @description The expression to match the page view count against */
119
+ match: components$6["schemas"]["NumberMatch"];
120
+ };
121
+ /** @description Describes a match expression on a string */
122
+ StringMatch: {
123
+ /** @description The right hand side of the match expression */
124
+ rhs: string;
125
+ /**
126
+ * @description The match operator
127
+ * '=' = exact match
128
+ * '~' = contains match
129
+ * '//' = regular expression match
130
+ *
131
+ * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
132
+ *
133
+ * @enum {string}
134
+ */
135
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
136
+ /** @description The case sensitivity of the match. Defaults to false if unspecified. */
137
+ cs?: boolean;
138
+ } | {
139
+ /**
140
+ * @description The type of match to perform
141
+ * '*' = exists with any value
142
+ * '!*' = does not exist
143
+ *
144
+ * @enum {string}
145
+ */
146
+ op: "*" | "!*";
147
+ };
148
+ /** @description Describes a match expression on a number */
149
+ NumberMatch: {
150
+ /** @description The right hand side of the match expression */
151
+ rhs: number;
152
+ /**
153
+ * @description The type of match to perform
154
+ * '=' = exact match
155
+ * '!=' = not an exact match
156
+ * '<' = less than match expression
157
+ * '>' = greater than match expression
158
+ *
159
+ * @enum {string}
160
+ */
161
+ op: "=" | "<" | ">" | "!=";
162
+ };
163
+ /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
164
+ AggregateDimension: {
165
+ /** @description Input dimensions to the aggregate dimension */
166
+ inputs: components$6["schemas"]["AggregateDimensionInput"][];
167
+ };
168
+ /** @description Defines an input dimension to an aggregate dimension */
169
+ AggregateDimensionInput: {
170
+ /**
171
+ * @description Dimension name to reference as an input.
172
+ * For enrichment inputs, use CATEGORY_KEY as the dimension.
173
+ * Enrichments, signals, and other aggregate dimensions may be referenced.
174
+ *
175
+ * Note that creating a cycle of aggregate dimensions is allowed, however
176
+ * the final score will _ignore_ the cycled aggregate dimension in the result.
177
+ * This can be used to create mutually exclusive aggregates.
178
+ */
179
+ dim: string;
180
+ /**
181
+ * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
182
+ *
183
+ * '+' = add to the final score
184
+ * '-' = subtract from the final score
185
+ * 'c' = clear the final score (if the input dimension has any score at all, this aggreate will have no score regardless of other inputs)
186
+ *
187
+ * Default if unspecified: '+'
188
+ *
189
+ * @default +
190
+ * @enum {string}
191
+ */
192
+ sign?: "+" | "-" | "c";
193
+ };
194
+ Test: {
195
+ /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
196
+ wv?: string;
197
+ };
198
+ };
199
+ }
200
+
3
201
  /**
4
202
  * This file was auto-generated by openapi-typescript.
5
203
  * Do not make direct changes to the file.
6
204
  */
7
205
  interface paths$6 {
8
- "/api/v1/enrichments": {
9
- get: {
10
- parameters: {
11
- query: {
12
- projectId: string;
13
- };
14
- };
15
- responses: {
16
- /** OK */
17
- 200: {
18
- content: {
19
- "application/json": {
20
- enrichments: components$6["schemas"]["EnrichmentCategoryWithValues"][];
21
- };
22
- };
23
- };
24
- 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
25
- 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
26
- 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
27
- 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
28
- 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
29
- };
30
- };
206
+ "/api/v1/enrichment-values": {
31
207
  put: {
32
208
  responses: {
33
209
  /** OK */
@@ -41,7 +217,8 @@ interface paths$6 {
41
217
  requestBody: {
42
218
  content: {
43
219
  "application/json": {
44
- enrichment: components$6["schemas"]["EnrichmentCategory"];
220
+ enrichmentValue: external$6["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentValue"];
221
+ enrichmentId: string;
45
222
  /** Format: uuid */
46
223
  projectId: string;
47
224
  };
@@ -55,6 +232,8 @@ interface paths$6 {
55
232
  400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
56
233
  401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
57
234
  403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
235
+ /** Parent enrichment category was not found */
236
+ 404: unknown;
58
237
  429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
59
238
  500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
60
239
  };
@@ -64,6 +243,7 @@ interface paths$6 {
64
243
  enrichmentId: string;
65
244
  /** Format: uuid */
66
245
  projectId: string;
246
+ enrichmentValueId: string;
67
247
  };
68
248
  };
69
249
  };
@@ -77,34 +257,6 @@ interface paths$6 {
77
257
  };
78
258
  };
79
259
  }
80
- interface components$6 {
81
- schemas: {
82
- EnrichmentCategory: {
83
- /** @description Public ID of the enrichment category */
84
- id: string;
85
- /** @description Display name of the enrichment category */
86
- name: string;
87
- /** @description Optional sort order of the enrichment category (if not set, sorts by name) */
88
- sortOrder?: number | null;
89
- /**
90
- * @description The maximum visitor score allowed for enrichment keys in this category
91
- * @default 99999999
92
- */
93
- cap?: number;
94
- };
95
- EnrichmentCategoryWithValues: components$6["schemas"]["EnrichmentCategory"] & {
96
- values: components$6["schemas"]["EnrichmentValue"][];
97
- };
98
- EnrichmentValue: {
99
- /** @description Public ID of the enrichment value */
100
- id: string;
101
- /** @description Display name of the enrichment value */
102
- value: string;
103
- /** @description Optional sort order of the enrichment value (if not set, sorts by name) */
104
- sortOrder?: number | null;
105
- };
106
- };
107
- }
108
260
  interface external$6 {
109
261
  "swagger.yml": {
110
262
  paths: {};
@@ -148,110 +300,6 @@ interface external$6 {
148
300
  };
149
301
  operations: {};
150
302
  };
151
- }
152
-
153
- /**
154
- * This file was auto-generated by openapi-typescript.
155
- * Do not make direct changes to the file.
156
- */
157
- interface paths$5 {
158
- "/api/v1/enrichment-values": {
159
- put: {
160
- responses: {
161
- /** OK */
162
- 204: never;
163
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
164
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
165
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
166
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
167
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
168
- };
169
- requestBody: {
170
- content: {
171
- "application/json": {
172
- enrichmentValue: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentValue"];
173
- enrichmentId: string;
174
- /** Format: uuid */
175
- projectId: string;
176
- };
177
- };
178
- };
179
- };
180
- delete: {
181
- responses: {
182
- /** OK */
183
- 204: never;
184
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
185
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
186
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
187
- /** Parent enrichment category was not found */
188
- 404: unknown;
189
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
190
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
191
- };
192
- requestBody: {
193
- content: {
194
- "application/json": {
195
- enrichmentId: string;
196
- /** Format: uuid */
197
- projectId: string;
198
- enrichmentValueId: string;
199
- };
200
- };
201
- };
202
- };
203
- /** Handles preflight requests. This endpoint allows CORS. */
204
- options: {
205
- responses: {
206
- /** OK */
207
- 204: never;
208
- };
209
- };
210
- };
211
- }
212
- interface external$5 {
213
- "swagger.yml": {
214
- paths: {};
215
- components: {
216
- schemas: {
217
- Error: {
218
- /** @description Error message(s) that occurred while processing the request */
219
- errorMessage?: string[] | string;
220
- };
221
- };
222
- responses: {
223
- /** Request input validation failed */
224
- BadRequestError: {
225
- content: {
226
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
227
- };
228
- };
229
- /** API key or token was not valid */
230
- UnauthorizedError: {
231
- content: {
232
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
233
- };
234
- };
235
- /** Permission was denied */
236
- ForbiddenError: {
237
- content: {
238
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
239
- };
240
- };
241
- /** Resource not found */
242
- NotFoundError: {
243
- content: {
244
- "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
245
- };
246
- };
247
- /** Too many requests in allowed time period */
248
- RateLimitError: unknown;
249
- /** Execution error occurred */
250
- InternalServerError: unknown;
251
- };
252
- };
253
- operations: {};
254
- };
255
303
  "v1-enrichments.swagger.yml": {
256
304
  paths: {
257
305
  "/api/v1/enrichments": {
@@ -266,31 +314,31 @@ interface external$5 {
266
314
  200: {
267
315
  content: {
268
316
  "application/json": {
269
- enrichments: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategoryWithValues"][];
317
+ enrichments: external$6["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategoryWithValues"][];
270
318
  };
271
319
  };
272
320
  };
273
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
274
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
275
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
276
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
277
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
321
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
322
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
323
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
324
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
325
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
278
326
  };
279
327
  };
280
328
  put: {
281
329
  responses: {
282
330
  /** OK */
283
331
  204: never;
284
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
285
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
286
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
287
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
288
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
332
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
333
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
334
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
335
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
336
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
289
337
  };
290
338
  requestBody: {
291
339
  content: {
292
340
  "application/json": {
293
- enrichment: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategory"];
341
+ enrichment: external$6["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategory"];
294
342
  /** Format: uuid */
295
343
  projectId: string;
296
344
  };
@@ -301,11 +349,11 @@ interface external$5 {
301
349
  responses: {
302
350
  /** OK */
303
351
  204: never;
304
- 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
305
- 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
306
- 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
307
- 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
308
- 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
352
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
353
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
354
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
355
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
356
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
309
357
  };
310
358
  requestBody: {
311
359
  content: {
@@ -341,8 +389,8 @@ interface external$5 {
341
389
  */
342
390
  cap?: number;
343
391
  };
344
- EnrichmentCategoryWithValues: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategory"] & {
345
- values: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentValue"][];
392
+ EnrichmentCategoryWithValues: external$6["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategory"] & {
393
+ values: external$6["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentValue"][];
346
394
  };
347
395
  EnrichmentValue: {
348
396
  /** @description Public ID of the enrichment value */
@@ -358,6 +406,156 @@ interface external$5 {
358
406
  };
359
407
  }
360
408
 
409
+ /**
410
+ * This file was auto-generated by openapi-typescript.
411
+ * Do not make direct changes to the file.
412
+ */
413
+ interface paths$5 {
414
+ "/api/v1/enrichments": {
415
+ get: {
416
+ parameters: {
417
+ query: {
418
+ projectId: string;
419
+ };
420
+ };
421
+ responses: {
422
+ /** OK */
423
+ 200: {
424
+ content: {
425
+ "application/json": {
426
+ enrichments: components$5["schemas"]["EnrichmentCategoryWithValues"][];
427
+ };
428
+ };
429
+ };
430
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
431
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
432
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
433
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
434
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
435
+ };
436
+ };
437
+ put: {
438
+ responses: {
439
+ /** OK */
440
+ 204: never;
441
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
442
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
443
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
444
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
445
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
446
+ };
447
+ requestBody: {
448
+ content: {
449
+ "application/json": {
450
+ enrichment: components$5["schemas"]["EnrichmentCategory"];
451
+ /** Format: uuid */
452
+ projectId: string;
453
+ };
454
+ };
455
+ };
456
+ };
457
+ delete: {
458
+ responses: {
459
+ /** OK */
460
+ 204: never;
461
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
462
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
463
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
464
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
465
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
466
+ };
467
+ requestBody: {
468
+ content: {
469
+ "application/json": {
470
+ enrichmentId: string;
471
+ /** Format: uuid */
472
+ projectId: string;
473
+ };
474
+ };
475
+ };
476
+ };
477
+ /** Handles preflight requests. This endpoint allows CORS. */
478
+ options: {
479
+ responses: {
480
+ /** OK */
481
+ 204: never;
482
+ };
483
+ };
484
+ };
485
+ }
486
+ interface components$5 {
487
+ schemas: {
488
+ EnrichmentCategory: {
489
+ /** @description Public ID of the enrichment category */
490
+ id: string;
491
+ /** @description Display name of the enrichment category */
492
+ name: string;
493
+ /** @description Optional sort order of the enrichment category (if not set, sorts by name) */
494
+ sortOrder?: number | null;
495
+ /**
496
+ * @description The maximum visitor score allowed for enrichment keys in this category
497
+ * @default 99999999
498
+ */
499
+ cap?: number;
500
+ };
501
+ EnrichmentCategoryWithValues: components$5["schemas"]["EnrichmentCategory"] & {
502
+ values: components$5["schemas"]["EnrichmentValue"][];
503
+ };
504
+ EnrichmentValue: {
505
+ /** @description Public ID of the enrichment value */
506
+ id: string;
507
+ /** @description Display name of the enrichment value */
508
+ value: string;
509
+ /** @description Optional sort order of the enrichment value (if not set, sorts by name) */
510
+ sortOrder?: number | null;
511
+ };
512
+ };
513
+ }
514
+ interface external$5 {
515
+ "swagger.yml": {
516
+ paths: {};
517
+ components: {
518
+ schemas: {
519
+ Error: {
520
+ /** @description Error message(s) that occurred while processing the request */
521
+ errorMessage?: string[] | string;
522
+ };
523
+ };
524
+ responses: {
525
+ /** Request input validation failed */
526
+ BadRequestError: {
527
+ content: {
528
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
529
+ };
530
+ };
531
+ /** API key or token was not valid */
532
+ UnauthorizedError: {
533
+ content: {
534
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
535
+ };
536
+ };
537
+ /** Permission was denied */
538
+ ForbiddenError: {
539
+ content: {
540
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
541
+ };
542
+ };
543
+ /** Resource not found */
544
+ NotFoundError: {
545
+ content: {
546
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
547
+ };
548
+ };
549
+ /** Too many requests in allowed time period */
550
+ RateLimitError: unknown;
551
+ /** Execution error occurred */
552
+ InternalServerError: unknown;
553
+ };
554
+ };
555
+ operations: {};
556
+ };
557
+ }
558
+
361
559
  /**
362
560
  * This file was auto-generated by openapi-typescript.
363
561
  * Do not make direct changes to the file.
@@ -384,7 +582,7 @@ interface paths$4 {
384
582
  200: {
385
583
  content: {
386
584
  "application/json": {
387
- aggregates: components$5["schemas"]["AggregateData"][];
585
+ aggregates: components$4["schemas"]["AggregateData"][];
388
586
  };
389
587
  };
390
588
  };
@@ -408,7 +606,7 @@ interface paths$4 {
408
606
  requestBody: {
409
607
  content: {
410
608
  "application/json": {
411
- aggregate: components$5["schemas"]["AggregateData"];
609
+ aggregate: components$4["schemas"]["AggregateData"];
412
610
  /** Format: uuid */
413
611
  projectId: string;
414
612
  /**
@@ -452,7 +650,7 @@ interface paths$4 {
452
650
  };
453
651
  };
454
652
  }
455
- interface components$5 {
653
+ interface components$4 {
456
654
  schemas: {
457
655
  AggregateData: {
458
656
  id: string;
@@ -734,7 +932,7 @@ interface paths$3 {
734
932
  200: {
735
933
  content: {
736
934
  "application/json": {
737
- dimensions: components$4["schemas"]["DimensionDefinition"][];
935
+ dimensions: components$3["schemas"]["DimensionDefinition"][];
738
936
  };
739
937
  };
740
938
  };
@@ -754,7 +952,7 @@ interface paths$3 {
754
952
  };
755
953
  };
756
954
  }
757
- interface components$4 {
955
+ interface components$3 {
758
956
  schemas: {
759
957
  DimensionDefinition: {
760
958
  /** @description The dimension name (score key) */
@@ -853,7 +1051,7 @@ interface paths$2 {
853
1051
  200: {
854
1052
  content: {
855
1053
  "application/json": {
856
- quirks: components$3["schemas"]["Quirk"][];
1054
+ quirks: components$2["schemas"]["Quirk"][];
857
1055
  };
858
1056
  };
859
1057
  };
@@ -877,7 +1075,7 @@ interface paths$2 {
877
1075
  requestBody: {
878
1076
  content: {
879
1077
  "application/json": {
880
- quirk: components$3["schemas"]["Quirk"];
1078
+ quirk: components$2["schemas"]["Quirk"];
881
1079
  /** Format: uuid */
882
1080
  projectId: string;
883
1081
  };
@@ -913,14 +1111,14 @@ interface paths$2 {
913
1111
  };
914
1112
  };
915
1113
  }
916
- interface components$3 {
1114
+ interface components$2 {
917
1115
  schemas: {
918
1116
  Quirk: {
919
1117
  id: string;
920
1118
  name: string;
921
1119
  description?: string | null;
922
- options?: components$3["schemas"]["QuirkOptions"][];
923
- source?: components$3["schemas"]["QuirkSource"];
1120
+ options?: components$2["schemas"]["QuirkOptions"][];
1121
+ source?: components$2["schemas"]["QuirkSource"];
924
1122
  };
925
1123
  QuirkOptions: {
926
1124
  name: string;
@@ -983,15 +1181,14 @@ interface external$2 {
983
1181
  * Do not make direct changes to the file.
984
1182
  */
985
1183
  interface paths$1 {
986
- "/api/v2/test": {
987
- /** Gets A/B test definitions for a project */
1184
+ "/api/v2/signal": {
988
1185
  get: {
989
1186
  parameters: {
990
1187
  query: {
991
- /** The project to fetch tests for */
1188
+ /** The project to fetch signals for */
992
1189
  projectId: string;
993
- /** Limit the results to a specific test public ID */
994
- testId?: string;
1190
+ /** Limit the results to a specific signal ID */
1191
+ signalId?: string;
995
1192
  };
996
1193
  };
997
1194
  responses: {
@@ -999,7 +1196,7 @@ interface paths$1 {
999
1196
  200: {
1000
1197
  content: {
1001
1198
  "application/json": {
1002
- tests: components$2["schemas"]["Test"][];
1199
+ signals: components$1["schemas"]["SignalWithId"][];
1003
1200
  };
1004
1201
  };
1005
1202
  };
@@ -1023,7 +1220,7 @@ interface paths$1 {
1023
1220
  requestBody: {
1024
1221
  content: {
1025
1222
  "application/json": {
1026
- test: components$2["schemas"]["Test"];
1223
+ signal: components$1["schemas"]["SignalWithId"];
1027
1224
  /** Format: uuid */
1028
1225
  projectId: string;
1029
1226
  };
@@ -1043,7 +1240,7 @@ interface paths$1 {
1043
1240
  requestBody: {
1044
1241
  content: {
1045
1242
  "application/json": {
1046
- testId: string;
1243
+ signalId: string;
1047
1244
  /** Format: uuid */
1048
1245
  projectId: string;
1049
1246
  };
@@ -1059,16 +1256,11 @@ interface paths$1 {
1059
1256
  };
1060
1257
  };
1061
1258
  }
1062
- interface components$2 {
1259
+ interface components$1 {
1063
1260
  schemas: {
1064
- Test: {
1261
+ SignalWithId: {
1065
1262
  id: string;
1066
- name: string;
1067
- winning_variant_id?: string;
1068
- default_variant_id?: string;
1069
- /** @default false */
1070
- closed?: boolean;
1071
- };
1263
+ } & external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["PreviewSignal"];
1072
1264
  };
1073
1265
  }
1074
1266
  interface external$1 {
@@ -1114,138 +1306,6 @@ interface external$1 {
1114
1306
  };
1115
1307
  operations: {};
1116
1308
  };
1117
- }
1118
-
1119
- /**
1120
- * This file was auto-generated by openapi-typescript.
1121
- * Do not make direct changes to the file.
1122
- */
1123
- interface paths {
1124
- "/api/v2/signal": {
1125
- get: {
1126
- parameters: {
1127
- query: {
1128
- /** The project to fetch signals for */
1129
- projectId: string;
1130
- /** Limit the results to a specific signal ID */
1131
- signalId?: string;
1132
- };
1133
- };
1134
- responses: {
1135
- /** OK */
1136
- 200: {
1137
- content: {
1138
- "application/json": {
1139
- signals: components$1["schemas"]["SignalWithId"][];
1140
- };
1141
- };
1142
- };
1143
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1144
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1145
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1146
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1147
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1148
- };
1149
- };
1150
- put: {
1151
- responses: {
1152
- /** OK */
1153
- 204: never;
1154
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1155
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1156
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1157
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1158
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1159
- };
1160
- requestBody: {
1161
- content: {
1162
- "application/json": {
1163
- signal: components$1["schemas"]["SignalWithId"];
1164
- /** Format: uuid */
1165
- projectId: string;
1166
- };
1167
- };
1168
- };
1169
- };
1170
- delete: {
1171
- responses: {
1172
- /** OK */
1173
- 204: never;
1174
- 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1175
- 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1176
- 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1177
- 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1178
- 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1179
- };
1180
- requestBody: {
1181
- content: {
1182
- "application/json": {
1183
- signalId: string;
1184
- /** Format: uuid */
1185
- projectId: string;
1186
- };
1187
- };
1188
- };
1189
- };
1190
- /** Handles preflight requests. This endpoint allows CORS. */
1191
- options: {
1192
- responses: {
1193
- /** OK */
1194
- 204: never;
1195
- };
1196
- };
1197
- };
1198
- }
1199
- interface components$1 {
1200
- schemas: {
1201
- SignalWithId: {
1202
- id: string;
1203
- } & external["uniform-context-types.swagger.yml"]["components"]["schemas"]["PreviewSignal"];
1204
- };
1205
- }
1206
- interface external {
1207
- "swagger.yml": {
1208
- paths: {};
1209
- components: {
1210
- schemas: {
1211
- Error: {
1212
- /** @description Error message(s) that occurred while processing the request */
1213
- errorMessage?: string[] | string;
1214
- };
1215
- };
1216
- responses: {
1217
- /** Request input validation failed */
1218
- BadRequestError: {
1219
- content: {
1220
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1221
- };
1222
- };
1223
- /** API key or token was not valid */
1224
- UnauthorizedError: {
1225
- content: {
1226
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1227
- };
1228
- };
1229
- /** Permission was denied */
1230
- ForbiddenError: {
1231
- content: {
1232
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1233
- };
1234
- };
1235
- /** Resource not found */
1236
- NotFoundError: {
1237
- content: {
1238
- "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1239
- };
1240
- };
1241
- /** Too many requests in allowed time period */
1242
- RateLimitError: unknown;
1243
- /** Execution error occurred */
1244
- InternalServerError: unknown;
1245
- };
1246
- };
1247
- operations: {};
1248
- };
1249
1309
  "uniform-context-types.swagger.yml": {
1250
1310
  paths: {};
1251
1311
  components: {
@@ -1254,7 +1314,7 @@ interface external {
1254
1314
  /** @description The maximum visitor score allowed for enrichment keys in this category */
1255
1315
  cap: number;
1256
1316
  };
1257
- PreviewSignal: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Signal"] & {
1317
+ PreviewSignal: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["Signal"] & {
1258
1318
  /** @description Friendly name of the signal */
1259
1319
  name: string;
1260
1320
  /** @description Description of the signal */
@@ -1274,7 +1334,7 @@ interface external {
1274
1334
  * @enum {string}
1275
1335
  */
1276
1336
  dur: "s" | "p" | "t";
1277
- crit: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
1337
+ crit: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
1278
1338
  };
1279
1339
  RootSignalCriteriaGroup: {
1280
1340
  /**
@@ -1294,7 +1354,7 @@ interface external {
1294
1354
  */
1295
1355
  op?: "&" | "|";
1296
1356
  /** @description The criteria clauses that make up this grouping of criteria */
1297
- clauses: (external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
1357
+ clauses: (external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
1298
1358
  };
1299
1359
  SignalCriteriaGroup: {
1300
1360
  /**
@@ -1313,9 +1373,9 @@ interface external {
1313
1373
  */
1314
1374
  op?: "&" | "|";
1315
1375
  /** @description The criteria clauses that make up this grouping of criteria */
1316
- clauses: (external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
1376
+ clauses: (external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
1317
1377
  };
1318
- SignalCriteria: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["CookieCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["QueryStringCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["EventCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["CurrentPageCriteria"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["PageViewCountCriteria"];
1378
+ SignalCriteria: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["CookieCriteria"] | external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["QueryStringCriteria"] | external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkCriteria"] | external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["EventCriteria"] | external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["CurrentPageCriteria"] | external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["PageViewCountCriteria"];
1319
1379
  /** @description Matches a URL query string parameter value */
1320
1380
  QueryStringCriteria: {
1321
1381
  /** @enum {string} */
@@ -1323,7 +1383,7 @@ interface external {
1323
1383
  /** @description The name of the query string parameter to match */
1324
1384
  queryName: string;
1325
1385
  /** @description The value to match the query string parameter against */
1326
- match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1386
+ match: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1327
1387
  };
1328
1388
  /** @description Matches a web cookie value */
1329
1389
  CookieCriteria: {
@@ -1332,7 +1392,7 @@ interface external {
1332
1392
  /** @description The name of the cookie to match */
1333
1393
  cookieName: string;
1334
1394
  /** @description The value to match the cookie against */
1335
- match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1395
+ match: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1336
1396
  };
1337
1397
  /** @description Matches a visitor quirk key and value */
1338
1398
  QuirkCriteria: {
@@ -1341,14 +1401,14 @@ interface external {
1341
1401
  /** @description The name of the quirk key to match */
1342
1402
  key: string;
1343
1403
  /** @description The quirk value to match against */
1344
- match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1404
+ match: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1345
1405
  };
1346
1406
  /** @description Matches an analytics event name being fired */
1347
1407
  EventCriteria: {
1348
1408
  /** @enum {string} */
1349
1409
  type: "EVT";
1350
1410
  /** @description How to match the event name */
1351
- event: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1411
+ event: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1352
1412
  };
1353
1413
  /**
1354
1414
  * @description Matches the current page's absolute path (i.e. /path/to/page.html)
@@ -1358,13 +1418,13 @@ interface external {
1358
1418
  /** @enum {string} */
1359
1419
  type: "PV";
1360
1420
  /** @description The page/route path to match as a page that has been visited */
1361
- path: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1421
+ path: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1362
1422
  };
1363
1423
  PageViewCountCriteria: {
1364
1424
  /** @enum {string} */
1365
1425
  type: "PVC";
1366
1426
  /** @description The expression to match the page view count against */
1367
- match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
1427
+ match: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
1368
1428
  };
1369
1429
  /** @description Describes a match expression on a string */
1370
1430
  StringMatch: {
@@ -1411,7 +1471,7 @@ interface external {
1411
1471
  /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
1412
1472
  AggregateDimension: {
1413
1473
  /** @description Input dimensions to the aggregate dimension */
1414
- inputs: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
1474
+ inputs: external$1["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
1415
1475
  };
1416
1476
  /** @description Defines an input dimension to an aggregate dimension */
1417
1477
  AggregateDimensionInput: {
@@ -1449,217 +1509,157 @@ interface external {
1449
1509
  };
1450
1510
  }
1451
1511
 
1452
- interface components {
1453
- schemas: {
1454
- EnrichmentCategory: {
1455
- /** @description The maximum visitor score allowed for enrichment keys in this category */
1456
- cap: number;
1457
- };
1458
- PreviewSignal: components["schemas"]["Signal"] & {
1459
- /** @description Friendly name of the signal */
1460
- name: string;
1461
- /** @description Description of the signal */
1462
- description?: string;
1463
- };
1464
- Signal: {
1465
- /** @description The signal strength per activation (each time its criteria are true, this score is added) */
1466
- str: number;
1467
- /** @description The maximum visitor score allowed for this signal */
1468
- cap: number;
1469
- /**
1470
- * @description How long the signal's score should persist
1471
- * 's' = current session (expires after a period of inactivity)
1472
- * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
1473
- * 't' = transient (score tracks the current state of the criteria every time scores are updated)
1474
- *
1475
- * @enum {string}
1476
- */
1477
- dur: "s" | "p" | "t";
1478
- crit: components["schemas"]["RootSignalCriteriaGroup"];
1479
- };
1480
- RootSignalCriteriaGroup: {
1481
- /**
1482
- * @description Criteria type (Group of other criteria)
1483
- * @enum {string}
1484
- */
1485
- type: "G";
1486
- /**
1487
- * @description The logical operator to apply to the criteria groups
1488
- * & = AND
1489
- * | = OR
1490
- *
1491
- * Default is `&` if unspecified.
1492
- *
1493
- * @default &
1494
- * @enum {string}
1495
- */
1496
- op?: "&" | "|";
1497
- /** @description The criteria clauses that make up this grouping of criteria */
1498
- clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
1499
- };
1500
- SignalCriteriaGroup: {
1501
- /**
1502
- * @description Criteria type (Group of other criteria)
1503
- * @enum {string}
1504
- */
1505
- type: "G";
1506
- /**
1507
- * @description The logical operator to apply to the criteria groups
1508
- * & = AND
1509
- * | = OR
1510
- *
1511
- * Default is `&` if unspecified.
1512
- *
1513
- * @enum {string}
1514
- */
1515
- op?: "&" | "|";
1516
- /** @description The criteria clauses that make up this grouping of criteria */
1517
- clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
1518
- };
1519
- SignalCriteria: components["schemas"]["CookieCriteria"] | components["schemas"]["QueryStringCriteria"] | components["schemas"]["QuirkCriteria"] | components["schemas"]["EventCriteria"] | components["schemas"]["CurrentPageCriteria"] | components["schemas"]["PageViewCountCriteria"];
1520
- /** @description Matches a URL query string parameter value */
1521
- QueryStringCriteria: {
1522
- /** @enum {string} */
1523
- type: "QS";
1524
- /** @description The name of the query string parameter to match */
1525
- queryName: string;
1526
- /** @description The value to match the query string parameter against */
1527
- match: components["schemas"]["StringMatch"];
1528
- };
1529
- /** @description Matches a web cookie value */
1530
- CookieCriteria: {
1531
- /** @enum {string} */
1532
- type: "CK";
1533
- /** @description The name of the cookie to match */
1534
- cookieName: string;
1535
- /** @description The value to match the cookie against */
1536
- match: components["schemas"]["StringMatch"];
1537
- };
1538
- /** @description Matches a visitor quirk key and value */
1539
- QuirkCriteria: {
1540
- /** @enum {string} */
1541
- type: "QK";
1542
- /** @description The name of the quirk key to match */
1543
- key: string;
1544
- /** @description The quirk value to match against */
1545
- match: components["schemas"]["StringMatch"];
1546
- };
1547
- /** @description Matches an analytics event name being fired */
1548
- EventCriteria: {
1549
- /** @enum {string} */
1550
- type: "EVT";
1551
- /** @description How to match the event name */
1552
- event: components["schemas"]["StringMatch"];
1553
- };
1554
- /**
1555
- * @description Matches the current page's absolute path (i.e. /path/to/page.html)
1556
- * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
1557
- */
1558
- CurrentPageCriteria: {
1559
- /** @enum {string} */
1560
- type: "PV";
1561
- /** @description The page/route path to match as a page that has been visited */
1562
- path: components["schemas"]["StringMatch"];
1563
- };
1564
- PageViewCountCriteria: {
1565
- /** @enum {string} */
1566
- type: "PVC";
1567
- /** @description The expression to match the page view count against */
1568
- match: components["schemas"]["NumberMatch"];
1569
- };
1570
- /** @description Describes a match expression on a string */
1571
- StringMatch: {
1572
- /** @description The right hand side of the match expression */
1573
- rhs: string;
1574
- /**
1575
- * @description The match operator
1576
- * '=' = exact match
1577
- * '~' = contains match
1578
- * '//' = regular expression match
1579
- *
1580
- * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
1581
- *
1582
- * @enum {string}
1583
- */
1584
- op: "=" | "~" | "//" | "!=" | "!~" | "!//";
1585
- /** @description The case sensitivity of the match. Defaults to false if unspecified. */
1586
- cs?: boolean;
1587
- } | {
1588
- /**
1589
- * @description The type of match to perform
1590
- * '*' = exists with any value
1591
- * '!*' = does not exist
1592
- *
1593
- * @enum {string}
1594
- */
1595
- op: "*" | "!*";
1512
+ /**
1513
+ * This file was auto-generated by openapi-typescript.
1514
+ * Do not make direct changes to the file.
1515
+ */
1516
+ interface paths {
1517
+ "/api/v2/test": {
1518
+ /** Gets A/B test definitions for a project */
1519
+ get: {
1520
+ parameters: {
1521
+ query: {
1522
+ /** The project to fetch tests for */
1523
+ projectId: string;
1524
+ /** Limit the results to a specific test public ID */
1525
+ testId?: string;
1526
+ };
1527
+ };
1528
+ responses: {
1529
+ /** OK */
1530
+ 200: {
1531
+ content: {
1532
+ "application/json": {
1533
+ tests: components["schemas"]["Test"][];
1534
+ };
1535
+ };
1536
+ };
1537
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1538
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1539
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1540
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1541
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1542
+ };
1596
1543
  };
1597
- /** @description Describes a match expression on a number */
1598
- NumberMatch: {
1599
- /** @description The right hand side of the match expression */
1600
- rhs: number;
1601
- /**
1602
- * @description The type of match to perform
1603
- * '=' = exact match
1604
- * '!=' = not an exact match
1605
- * '<' = less than match expression
1606
- * '>' = greater than match expression
1607
- *
1608
- * @enum {string}
1609
- */
1610
- op: "=" | "<" | ">" | "!=";
1544
+ put: {
1545
+ responses: {
1546
+ /** OK */
1547
+ 204: never;
1548
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1549
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1550
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1551
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1552
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1553
+ };
1554
+ requestBody: {
1555
+ content: {
1556
+ "application/json": {
1557
+ test: components["schemas"]["Test"];
1558
+ /** Format: uuid */
1559
+ projectId: string;
1560
+ };
1561
+ };
1562
+ };
1611
1563
  };
1612
- /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
1613
- AggregateDimension: {
1614
- /** @description Input dimensions to the aggregate dimension */
1615
- inputs: components["schemas"]["AggregateDimensionInput"][];
1564
+ delete: {
1565
+ responses: {
1566
+ /** OK */
1567
+ 204: never;
1568
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1569
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1570
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1571
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1572
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1573
+ };
1574
+ requestBody: {
1575
+ content: {
1576
+ "application/json": {
1577
+ testId: string;
1578
+ /** Format: uuid */
1579
+ projectId: string;
1580
+ };
1581
+ };
1582
+ };
1616
1583
  };
1617
- /** @description Defines an input dimension to an aggregate dimension */
1618
- AggregateDimensionInput: {
1619
- /**
1620
- * @description Dimension name to reference as an input.
1621
- * For enrichment inputs, use CATEGORY_KEY as the dimension.
1622
- * Enrichments, signals, and other aggregate dimensions may be referenced.
1623
- *
1624
- * Note that creating a cycle of aggregate dimensions is allowed, however
1625
- * the final score will _ignore_ the cycled aggregate dimension in the result.
1626
- * This can be used to create mutually exclusive aggregates.
1627
- */
1628
- dim: string;
1629
- /**
1630
- * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
1631
- *
1632
- * '+' = add to the final score
1633
- * '-' = subtract from the final score
1634
- * 'c' = clear the final score (if the input dimension has any score at all, this aggreate will have no score regardless of other inputs)
1635
- *
1636
- * Default if unspecified: '+'
1637
- *
1638
- * @default +
1639
- * @enum {string}
1640
- */
1641
- sign?: "+" | "-" | "c";
1584
+ /** Handles preflight requests. This endpoint allows CORS. */
1585
+ options: {
1586
+ responses: {
1587
+ /** OK */
1588
+ 204: never;
1589
+ };
1642
1590
  };
1591
+ };
1592
+ }
1593
+ interface components {
1594
+ schemas: {
1643
1595
  Test: {
1644
- /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
1645
- wv?: string;
1596
+ id: string;
1597
+ name: string;
1598
+ winning_variant_id?: string;
1599
+ default_variant_id?: string;
1600
+ /** @default false */
1601
+ closed?: boolean;
1646
1602
  };
1647
1603
  };
1648
1604
  }
1605
+ interface external {
1606
+ "swagger.yml": {
1607
+ paths: {};
1608
+ components: {
1609
+ schemas: {
1610
+ Error: {
1611
+ /** @description Error message(s) that occurred while processing the request */
1612
+ errorMessage?: string[] | string;
1613
+ };
1614
+ };
1615
+ responses: {
1616
+ /** Request input validation failed */
1617
+ BadRequestError: {
1618
+ content: {
1619
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1620
+ };
1621
+ };
1622
+ /** API key or token was not valid */
1623
+ UnauthorizedError: {
1624
+ content: {
1625
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1626
+ };
1627
+ };
1628
+ /** Permission was denied */
1629
+ ForbiddenError: {
1630
+ content: {
1631
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1632
+ };
1633
+ };
1634
+ /** Resource not found */
1635
+ NotFoundError: {
1636
+ content: {
1637
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1638
+ };
1639
+ };
1640
+ /** Too many requests in allowed time period */
1641
+ RateLimitError: unknown;
1642
+ /** Execution error occurred */
1643
+ InternalServerError: unknown;
1644
+ };
1645
+ };
1646
+ operations: {};
1647
+ };
1648
+ }
1649
1649
 
1650
- declare type EnrichmentGet = paths$6['/api/v1/enrichments']['get'];
1650
+ declare type EnrichmentGet = paths$5['/api/v1/enrichments']['get'];
1651
1651
  declare type EnrichmentGetParameters = EnrichmentGet['parameters']['query'];
1652
1652
  declare type EnrichmentGetResponse = EnrichmentGet['responses']['200']['content']['application/json'];
1653
- declare type EnrichmentCategory = components$6['schemas']['EnrichmentCategory'];
1654
- declare type EnrichmentCategoryWithValues = components$6['schemas']['EnrichmentCategoryWithValues'];
1655
- declare type EnrichmentValue = components$6['schemas']['EnrichmentValue'];
1656
- declare type EnrichmentPut = paths$6['/api/v1/enrichments']['put'];
1653
+ declare type EnrichmentCategory = components$5['schemas']['EnrichmentCategory'];
1654
+ declare type EnrichmentCategoryWithValues = components$5['schemas']['EnrichmentCategoryWithValues'];
1655
+ declare type EnrichmentValue = components$5['schemas']['EnrichmentValue'];
1656
+ declare type EnrichmentPut = paths$5['/api/v1/enrichments']['put'];
1657
1657
  declare type EnrichmentPutParameters = EnrichmentPut['requestBody']['content']['application/json'];
1658
- declare type EnrichmentDelete = paths$6['/api/v1/enrichments']['delete'];
1658
+ declare type EnrichmentDelete = paths$5['/api/v1/enrichments']['delete'];
1659
1659
  declare type EnrichmentDeleteParameters = EnrichmentDelete['requestBody']['content']['application/json'];
1660
- declare type EnrichmentValuePut = paths$5['/api/v1/enrichment-values']['put'];
1660
+ declare type EnrichmentValuePut = paths$6['/api/v1/enrichment-values']['put'];
1661
1661
  declare type EnrichmentValuePutParameters = EnrichmentValuePut['requestBody']['content']['application/json'];
1662
- declare type EnrichmentValueDelete = paths$5['/api/v1/enrichment-values']['delete'];
1662
+ declare type EnrichmentValueDelete = paths$6['/api/v1/enrichment-values']['delete'];
1663
1663
  declare type EnrichmentValueDeleteParameters = EnrichmentValueDelete['requestBody']['content']['application/json'];
1664
1664
  declare type ManifestGet = paths$7['/api/v2/manifest']['get'];
1665
1665
  declare type ManifestGetParameters = ManifestGet['parameters']['query'];
@@ -1667,7 +1667,7 @@ declare type ManifestGetResponse = ManifestGet['responses']['200']['content']['a
1667
1667
  declare type AggregateGet = paths$4['/api/v2/aggregate']['get'];
1668
1668
  declare type AggregateGetParameters = AggregateGet['parameters']['query'];
1669
1669
  declare type AggregateGetResponse = AggregateGet['responses']['200']['content']['application/json'];
1670
- declare type Aggregate = components$5['schemas']['AggregateData'];
1670
+ declare type Aggregate = components$4['schemas']['AggregateData'];
1671
1671
  declare type AggregatePut = paths$4['/api/v2/aggregate']['put'];
1672
1672
  declare type AggregatePutParameters = AggregatePut['requestBody']['content']['application/json'];
1673
1673
  declare type AggregateDelete = paths$4['/api/v2/aggregate']['delete'];
@@ -1675,37 +1675,37 @@ declare type AggregateDeleteParameters = AggregateDelete['requestBody']['content
1675
1675
  declare type DimensionGet = paths$3['/api/v2/dimension']['get'];
1676
1676
  declare type DimensionGetParameters = DimensionGet['parameters']['query'];
1677
1677
  declare type DimensionGetResponse = DimensionGet['responses']['200']['content']['application/json'];
1678
- declare type DimensionDefinition = components$4['schemas']['DimensionDefinition'];
1678
+ declare type DimensionDefinition = components$3['schemas']['DimensionDefinition'];
1679
1679
  declare type QuirkGet = paths$2['/api/v2/quirk']['get'];
1680
1680
  declare type QuirkGetParameters = QuirkGet['parameters']['query'];
1681
1681
  declare type QuirkGetResponse = QuirkGet['responses']['200']['content']['application/json'];
1682
- declare type Quirk = components$3['schemas']['Quirk'];
1682
+ declare type Quirk = components$2['schemas']['Quirk'];
1683
1683
  declare type QuirkPut = paths$2['/api/v2/quirk']['put'];
1684
1684
  declare type QuirkPutParameters = QuirkPut['requestBody']['content']['application/json'];
1685
1685
  declare type QuirkDelete = paths$2['/api/v2/quirk']['delete'];
1686
1686
  declare type QuirkDeleteParameters = QuirkDelete['requestBody']['content']['application/json'];
1687
- declare type TestGet = paths$1['/api/v2/test']['get'];
1687
+ declare type TestGet = paths['/api/v2/test']['get'];
1688
1688
  declare type TestGetParameters = TestGet['parameters']['query'];
1689
1689
  declare type TestGetResponse = TestGet['responses']['200']['content']['application/json'];
1690
- declare type Test = components$2['schemas']['Test'];
1691
- declare type TestPut = paths$1['/api/v2/test']['put'];
1690
+ declare type Test = components['schemas']['Test'];
1691
+ declare type TestPut = paths['/api/v2/test']['put'];
1692
1692
  declare type TestPutParameters = TestPut['requestBody']['content']['application/json'];
1693
- declare type TestDelete = paths$1['/api/v2/test']['delete'];
1693
+ declare type TestDelete = paths['/api/v2/test']['delete'];
1694
1694
  declare type TestDeleteParameters = TestDelete['requestBody']['content']['application/json'];
1695
- declare type SignalGet = paths['/api/v2/signal']['get'];
1695
+ declare type SignalGet = paths$1['/api/v2/signal']['get'];
1696
1696
  declare type SignalGetParameters = SignalGet['parameters']['query'];
1697
1697
  declare type SignalGetResponse = SignalGet['responses']['200']['content']['application/json'];
1698
1698
  declare type SignalWithId = components$1['schemas']['SignalWithId'];
1699
- declare type RootSignalCriteriaGroup = components['schemas']['RootSignalCriteriaGroup'];
1700
- declare type CookieCriteria = components['schemas']['CookieCriteria'];
1701
- declare type QueryStringCriteria = components['schemas']['QueryStringCriteria'];
1702
- declare type QuirkCriteria = components['schemas']['QuirkCriteria'];
1703
- declare type EventCriteria = components['schemas']['EventCriteria'];
1704
- declare type CurrentPageCriteria = components['schemas']['CurrentPageCriteria'];
1705
- declare type PageViewCountCriteria = components['schemas']['PageViewCountCriteria'];
1706
- declare type SignalPut = paths['/api/v2/signal']['put'];
1699
+ declare type RootSignalCriteriaGroup = components$6['schemas']['RootSignalCriteriaGroup'];
1700
+ declare type CookieCriteria = components$6['schemas']['CookieCriteria'];
1701
+ declare type QueryStringCriteria = components$6['schemas']['QueryStringCriteria'];
1702
+ declare type QuirkCriteria = components$6['schemas']['QuirkCriteria'];
1703
+ declare type EventCriteria = components$6['schemas']['EventCriteria'];
1704
+ declare type CurrentPageCriteria = components$6['schemas']['CurrentPageCriteria'];
1705
+ declare type PageViewCountCriteria = components$6['schemas']['PageViewCountCriteria'];
1706
+ declare type SignalPut = paths$1['/api/v2/signal']['put'];
1707
1707
  declare type SignalPutParameters = SignalPut['requestBody']['content']['application/json'];
1708
- declare type SignalDelete = paths['/api/v2/signal']['delete'];
1708
+ declare type SignalDelete = paths$1['/api/v2/signal']['delete'];
1709
1709
  declare type SignalDeleteParameters = SignalDelete['requestBody']['content']['application/json'];
1710
1710
  declare type ContextDefinitions = {
1711
1711
  aggregates?: Array<Aggregate>;
@@ -1715,4 +1715,4 @@ declare type ContextDefinitions = {
1715
1715
  tests?: Array<Test>;
1716
1716
  };
1717
1717
 
1718
- export { AggregateGetParameters as A, SignalWithId as B, ContextDefinitions as C, DimensionGetParameters as D, EnrichmentGetParameters as E, CookieCriteria as F, QueryStringCriteria as G, QuirkCriteria as H, EventCriteria as I, CurrentPageCriteria as J, ManifestGetParameters as M, PageViewCountCriteria as P, QuirkGetParameters as Q, RootSignalCriteriaGroup as R, SignalGetParameters as S, TestGetParameters as T, AggregateGetResponse as a, AggregatePutParameters as b, AggregateDeleteParameters as c, DimensionGetResponse as d, EnrichmentGetResponse as e, EnrichmentPutParameters as f, EnrichmentDeleteParameters as g, EnrichmentValuePutParameters as h, EnrichmentValueDeleteParameters as i, ManifestGetResponse as j, QuirkGetResponse as k, QuirkPutParameters as l, QuirkDeleteParameters as m, SignalGetResponse as n, SignalPutParameters as o, SignalDeleteParameters as p, TestGetResponse as q, TestPutParameters as r, TestDeleteParameters as s, DimensionDefinition as t, EnrichmentCategory as u, EnrichmentCategoryWithValues as v, EnrichmentValue as w, Aggregate as x, Quirk as y, Test as z };
1718
+ export { AggregateGetParameters as A, SignalWithId as B, ContextDefinitions as C, DimensionDefinition as D, EnrichmentGetParameters as E, CookieCriteria as F, QueryStringCriteria as G, QuirkCriteria as H, EventCriteria as I, CurrentPageCriteria as J, ManifestGetParameters as M, PageViewCountCriteria as P, QuirkGetParameters as Q, RootSignalCriteriaGroup as R, SignalGetParameters as S, TestGetParameters as T, AggregateGetResponse as a, AggregatePutParameters as b, AggregateDeleteParameters as c, DimensionGetParameters as d, DimensionGetResponse as e, EnrichmentGetResponse as f, EnrichmentPutParameters as g, EnrichmentDeleteParameters as h, EnrichmentValuePutParameters as i, EnrichmentValueDeleteParameters as j, ManifestGetResponse as k, QuirkGetResponse as l, QuirkPutParameters as m, QuirkDeleteParameters as n, SignalGetResponse as o, SignalPutParameters as p, SignalDeleteParameters as q, TestGetResponse as r, TestPutParameters as s, TestDeleteParameters as t, EnrichmentCategory as u, EnrichmentCategoryWithValues as v, EnrichmentValue as w, Aggregate as x, Quirk as y, Test as z };