@uniformdev/context 12.2.1-alpha.177 → 14.2.1-alpha.119

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.
@@ -0,0 +1,1534 @@
1
+ import { p as paths$7 } from './v2-manifest.swagger-d0899723';
2
+
3
+ /**
4
+ * This file was auto-generated by openapi-typescript.
5
+ * Do not make direct changes to the file.
6
+ */
7
+ 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
+ };
31
+ put: {
32
+ responses: {
33
+ /** OK */
34
+ 204: never;
35
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
36
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
37
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
38
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
39
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
40
+ };
41
+ requestBody: {
42
+ content: {
43
+ "application/json": {
44
+ enrichment: components$6["schemas"]["EnrichmentCategory"];
45
+ /** Format: uuid */
46
+ projectId: string;
47
+ };
48
+ };
49
+ };
50
+ };
51
+ delete: {
52
+ responses: {
53
+ /** OK */
54
+ 204: never;
55
+ 400: external$6["swagger.yml"]["components"]["responses"]["BadRequestError"];
56
+ 401: external$6["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
57
+ 403: external$6["swagger.yml"]["components"]["responses"]["ForbiddenError"];
58
+ 429: external$6["swagger.yml"]["components"]["responses"]["RateLimitError"];
59
+ 500: external$6["swagger.yml"]["components"]["responses"]["InternalServerError"];
60
+ };
61
+ requestBody: {
62
+ content: {
63
+ "application/json": {
64
+ enrichmentId: string;
65
+ /** Format: uuid */
66
+ projectId: string;
67
+ };
68
+ };
69
+ };
70
+ };
71
+ };
72
+ }
73
+ interface components$6 {
74
+ schemas: {
75
+ EnrichmentCategory: {
76
+ /** @description Public ID of the enrichment category */
77
+ id: string;
78
+ /** @description Display name of the enrichment category */
79
+ name: string;
80
+ /** @description Optional sort order of the enrichment category (if not set, sorts by name) */
81
+ sortOrder?: number | null;
82
+ /**
83
+ * @description The maximum visitor score allowed for enrichment keys in this category
84
+ * @default 99999999
85
+ */
86
+ cap?: number;
87
+ };
88
+ EnrichmentCategoryWithValues: components$6["schemas"]["EnrichmentCategory"] & {
89
+ values: components$6["schemas"]["EnrichmentValue"][];
90
+ };
91
+ EnrichmentValue: {
92
+ /** @description Public ID of the enrichment value */
93
+ id: string;
94
+ /** @description Display name of the enrichment value */
95
+ value: string;
96
+ /** @description Optional sort order of the enrichment value (if not set, sorts by name) */
97
+ sortOrder?: number | null;
98
+ };
99
+ };
100
+ }
101
+ interface external$6 {
102
+ "swagger.yml": {
103
+ paths: {};
104
+ components: {
105
+ schemas: {
106
+ Error: {
107
+ /** @description Error message(s) that occurred while processing the request */
108
+ errorMessage?: string[] | string;
109
+ };
110
+ };
111
+ responses: {
112
+ /** Request input validation failed */
113
+ BadRequestError: {
114
+ content: {
115
+ "application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
116
+ };
117
+ };
118
+ /** API key or token was not valid */
119
+ UnauthorizedError: {
120
+ content: {
121
+ "application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
122
+ };
123
+ };
124
+ /** Permission was denied */
125
+ ForbiddenError: {
126
+ content: {
127
+ "application/json": external$6["swagger.yml"]["components"]["schemas"]["Error"];
128
+ };
129
+ };
130
+ /** Too many requests in allowed time period */
131
+ RateLimitError: unknown;
132
+ /** Execution error occurred */
133
+ InternalServerError: unknown;
134
+ };
135
+ };
136
+ operations: {};
137
+ };
138
+ }
139
+
140
+ /**
141
+ * This file was auto-generated by openapi-typescript.
142
+ * Do not make direct changes to the file.
143
+ */
144
+ interface paths$5 {
145
+ "/api/v1/enrichment-values": {
146
+ put: {
147
+ responses: {
148
+ /** OK */
149
+ 204: never;
150
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
151
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
152
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
153
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
154
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
155
+ };
156
+ requestBody: {
157
+ content: {
158
+ "application/json": {
159
+ enrichmentValue: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentValue"];
160
+ enrichmentId: string;
161
+ /** Format: uuid */
162
+ projectId: string;
163
+ };
164
+ };
165
+ };
166
+ };
167
+ delete: {
168
+ responses: {
169
+ /** OK */
170
+ 204: never;
171
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
172
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
173
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
174
+ /** Parent enrichment category was not found */
175
+ 404: unknown;
176
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
177
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
178
+ };
179
+ requestBody: {
180
+ content: {
181
+ "application/json": {
182
+ enrichmentId: string;
183
+ /** Format: uuid */
184
+ projectId: string;
185
+ enrichmentValueId: string;
186
+ };
187
+ };
188
+ };
189
+ };
190
+ };
191
+ }
192
+ interface external$5 {
193
+ "swagger.yml": {
194
+ paths: {};
195
+ components: {
196
+ schemas: {
197
+ Error: {
198
+ /** @description Error message(s) that occurred while processing the request */
199
+ errorMessage?: string[] | string;
200
+ };
201
+ };
202
+ responses: {
203
+ /** Request input validation failed */
204
+ BadRequestError: {
205
+ content: {
206
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
207
+ };
208
+ };
209
+ /** API key or token was not valid */
210
+ UnauthorizedError: {
211
+ content: {
212
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
213
+ };
214
+ };
215
+ /** Permission was denied */
216
+ ForbiddenError: {
217
+ content: {
218
+ "application/json": external$5["swagger.yml"]["components"]["schemas"]["Error"];
219
+ };
220
+ };
221
+ /** Too many requests in allowed time period */
222
+ RateLimitError: unknown;
223
+ /** Execution error occurred */
224
+ InternalServerError: unknown;
225
+ };
226
+ };
227
+ operations: {};
228
+ };
229
+ "v1-enrichments.swagger.yml": {
230
+ paths: {
231
+ "/api/v1/enrichments": {
232
+ get: {
233
+ parameters: {
234
+ query: {
235
+ projectId: string;
236
+ };
237
+ };
238
+ responses: {
239
+ /** OK */
240
+ 200: {
241
+ content: {
242
+ "application/json": {
243
+ enrichments: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategoryWithValues"][];
244
+ };
245
+ };
246
+ };
247
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
248
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
249
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
250
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
251
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
252
+ };
253
+ };
254
+ put: {
255
+ responses: {
256
+ /** OK */
257
+ 204: never;
258
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
259
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
260
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
261
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
262
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
263
+ };
264
+ requestBody: {
265
+ content: {
266
+ "application/json": {
267
+ enrichment: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategory"];
268
+ /** Format: uuid */
269
+ projectId: string;
270
+ };
271
+ };
272
+ };
273
+ };
274
+ delete: {
275
+ responses: {
276
+ /** OK */
277
+ 204: never;
278
+ 400: external$5["swagger.yml"]["components"]["responses"]["BadRequestError"];
279
+ 401: external$5["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
280
+ 403: external$5["swagger.yml"]["components"]["responses"]["ForbiddenError"];
281
+ 429: external$5["swagger.yml"]["components"]["responses"]["RateLimitError"];
282
+ 500: external$5["swagger.yml"]["components"]["responses"]["InternalServerError"];
283
+ };
284
+ requestBody: {
285
+ content: {
286
+ "application/json": {
287
+ enrichmentId: string;
288
+ /** Format: uuid */
289
+ projectId: string;
290
+ };
291
+ };
292
+ };
293
+ };
294
+ };
295
+ };
296
+ components: {
297
+ schemas: {
298
+ EnrichmentCategory: {
299
+ /** @description Public ID of the enrichment category */
300
+ id: string;
301
+ /** @description Display name of the enrichment category */
302
+ name: string;
303
+ /** @description Optional sort order of the enrichment category (if not set, sorts by name) */
304
+ sortOrder?: number | null;
305
+ /**
306
+ * @description The maximum visitor score allowed for enrichment keys in this category
307
+ * @default 99999999
308
+ */
309
+ cap?: number;
310
+ };
311
+ EnrichmentCategoryWithValues: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentCategory"] & {
312
+ values: external$5["v1-enrichments.swagger.yml"]["components"]["schemas"]["EnrichmentValue"][];
313
+ };
314
+ EnrichmentValue: {
315
+ /** @description Public ID of the enrichment value */
316
+ id: string;
317
+ /** @description Display name of the enrichment value */
318
+ value: string;
319
+ /** @description Optional sort order of the enrichment value (if not set, sorts by name) */
320
+ sortOrder?: number | null;
321
+ };
322
+ };
323
+ };
324
+ operations: {};
325
+ };
326
+ }
327
+
328
+ /**
329
+ * This file was auto-generated by openapi-typescript.
330
+ * Do not make direct changes to the file.
331
+ */
332
+ interface paths$4 {
333
+ "/api/v2/aggregate": {
334
+ get: {
335
+ parameters: {
336
+ query: {
337
+ /** The project to fetch aggregates for */
338
+ projectId: string;
339
+ /** Limit the results to a specific aggregate ID */
340
+ aggregateId?: string;
341
+ /**
342
+ * Limit the results to a specific aggregate type
343
+ * 0: Audience
344
+ * 1: Intent
345
+ */
346
+ type?: 0 | 1;
347
+ };
348
+ };
349
+ responses: {
350
+ /** OK */
351
+ 200: {
352
+ content: {
353
+ "application/json": {
354
+ aggregates: components$5["schemas"]["AggregateData"][];
355
+ };
356
+ };
357
+ };
358
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
359
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
360
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
361
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
362
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
363
+ };
364
+ };
365
+ put: {
366
+ responses: {
367
+ /** OK */
368
+ 204: never;
369
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
370
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
371
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
372
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
373
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
374
+ };
375
+ requestBody: {
376
+ content: {
377
+ "application/json": {
378
+ aggregate: components$5["schemas"]["AggregateData"];
379
+ /** Format: uuid */
380
+ projectId: string;
381
+ /**
382
+ * @description Skips updating aggregate inputs and upserts only the aggregate definition.
383
+ * Inputs data is still required, but is ignored and not saved or validated.
384
+ * Useful when creating aggregates that reference each other: Create the definitions, then the inputs.
385
+ */
386
+ skipInputs?: boolean;
387
+ };
388
+ };
389
+ };
390
+ };
391
+ delete: {
392
+ responses: {
393
+ /** OK */
394
+ 204: never;
395
+ 400: external$4["swagger.yml"]["components"]["responses"]["BadRequestError"];
396
+ 401: external$4["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
397
+ 403: external$4["swagger.yml"]["components"]["responses"]["ForbiddenError"];
398
+ 429: external$4["swagger.yml"]["components"]["responses"]["RateLimitError"];
399
+ 500: external$4["swagger.yml"]["components"]["responses"]["InternalServerError"];
400
+ };
401
+ requestBody: {
402
+ content: {
403
+ "application/json": {
404
+ aggregateId: string;
405
+ /** Format: uuid */
406
+ projectId: string;
407
+ };
408
+ };
409
+ };
410
+ };
411
+ };
412
+ }
413
+ interface components$5 {
414
+ schemas: {
415
+ AggregateData: {
416
+ id: string;
417
+ name: string;
418
+ description?: string;
419
+ /**
420
+ * @description The type of aggregate
421
+ * 0: Audience
422
+ * 1: Intent
423
+ */
424
+ type: 0 | 1;
425
+ inputs: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
426
+ };
427
+ };
428
+ }
429
+ interface external$4 {
430
+ "swagger.yml": {
431
+ paths: {};
432
+ components: {
433
+ schemas: {
434
+ Error: {
435
+ /** @description Error message(s) that occurred while processing the request */
436
+ errorMessage?: string[] | string;
437
+ };
438
+ };
439
+ responses: {
440
+ /** Request input validation failed */
441
+ BadRequestError: {
442
+ content: {
443
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
444
+ };
445
+ };
446
+ /** API key or token was not valid */
447
+ UnauthorizedError: {
448
+ content: {
449
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
450
+ };
451
+ };
452
+ /** Permission was denied */
453
+ ForbiddenError: {
454
+ content: {
455
+ "application/json": external$4["swagger.yml"]["components"]["schemas"]["Error"];
456
+ };
457
+ };
458
+ /** Too many requests in allowed time period */
459
+ RateLimitError: unknown;
460
+ /** Execution error occurred */
461
+ InternalServerError: unknown;
462
+ };
463
+ };
464
+ operations: {};
465
+ };
466
+ "uniform-context-types.swagger.yml": {
467
+ paths: {};
468
+ components: {
469
+ schemas: {
470
+ EnrichmentCategory: {
471
+ /** @description The maximum visitor score allowed for enrichment keys in this category */
472
+ cap: number;
473
+ };
474
+ PreviewSignal: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["Signal"] & {
475
+ /** @description Friendly name of the signal */
476
+ name: string;
477
+ /** @description Description of the signal */
478
+ description?: string;
479
+ };
480
+ Signal: {
481
+ /** @description The signal strength per activation (each time its criteria are true, this score is added) */
482
+ str: number;
483
+ /** @description The maximum visitor score allowed for this signal */
484
+ cap: number;
485
+ /**
486
+ * @description How long the signal's score should persist
487
+ * 's' = current session (expires after a period of inactivity)
488
+ * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
489
+ * 't' = transient (score tracks the current state of the criteria every time scores are updated)
490
+ */
491
+ dur: "s" | "p" | "t";
492
+ crit: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
493
+ };
494
+ RootSignalCriteriaGroup: {
495
+ /** @description Criteria type (Group of other criteria) */
496
+ type: "G";
497
+ /**
498
+ * @description The logical operator to apply to the criteria groups
499
+ * & = AND
500
+ * | = OR
501
+ *
502
+ * Default is `&` if unspecified.
503
+ *
504
+ * @default &
505
+ */
506
+ op?: "&" | "|";
507
+ /** @description The criteria clauses that make up this grouping of criteria */
508
+ clauses: (external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
509
+ };
510
+ SignalCriteriaGroup: {
511
+ /** @description Criteria type (Group of other criteria) */
512
+ type: "G";
513
+ /**
514
+ * @description The logical operator to apply to the criteria groups
515
+ * & = AND
516
+ * | = OR
517
+ *
518
+ * Default is `&` if unspecified.
519
+ */
520
+ op?: "&" | "|";
521
+ /** @description The criteria clauses that make up this grouping of criteria */
522
+ clauses: (external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
523
+ };
524
+ SignalCriteria: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["CookieCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["QueryStringCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["QuirkCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["EventCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["CurrentPageCriteria"] | external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["PageViewCountCriteria"];
525
+ /** @description Matches a URL query string parameter value */
526
+ QueryStringCriteria: {
527
+ type: "QS";
528
+ /** @description The name of the query string parameter to match */
529
+ queryName: string;
530
+ /** @description The value to match the query string parameter against */
531
+ match: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
532
+ };
533
+ /** @description Matches a web cookie value */
534
+ CookieCriteria: {
535
+ type: "CK";
536
+ /** @description The name of the cookie to match */
537
+ cookieName: string;
538
+ /** @description The value to match the cookie against */
539
+ match: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
540
+ };
541
+ /** @description Matches a visitor quirk key and value */
542
+ QuirkCriteria: {
543
+ type: "QK";
544
+ /** @description The name of the quirk key to match */
545
+ key: string;
546
+ /** @description The quirk value to match against */
547
+ match: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
548
+ };
549
+ /** @description Matches an analytics event name being fired */
550
+ EventCriteria: {
551
+ type: "EVT";
552
+ /** @description How to match the event name */
553
+ event: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
554
+ };
555
+ /**
556
+ * @description Matches the current page's absolute path (i.e. /path/to/page.html)
557
+ * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
558
+ */
559
+ CurrentPageCriteria: {
560
+ type: "PV";
561
+ /** @description The page/route path to match as a page that has been visited */
562
+ path: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
563
+ };
564
+ PageViewCountCriteria: {
565
+ type: "PVC";
566
+ /** @description The expression to match the page view count against */
567
+ match: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
568
+ };
569
+ /** @description Describes a match expression on a string */
570
+ StringMatch: {
571
+ /** @description The right hand side of the match expression */
572
+ rhs: string;
573
+ /**
574
+ * @description The match operator
575
+ * '=' = exact match
576
+ * '~' = contains match
577
+ * '//' = regular expression match
578
+ *
579
+ * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
580
+ */
581
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
582
+ /** @description The case sensitivity of the match. Defaults to false if unspecified. */
583
+ cs?: boolean;
584
+ } | {
585
+ /**
586
+ * @description The type of match to perform
587
+ * '*' = exists with any value
588
+ * '!*' = does not exist
589
+ */
590
+ op: "*" | "!*";
591
+ };
592
+ /** @description Describes a match expression on a number */
593
+ NumberMatch: {
594
+ /** @description The right hand side of the match expression */
595
+ rhs: number;
596
+ /**
597
+ * @description The type of match to perform
598
+ * '=' = exact match
599
+ * '!=' = not an exact match
600
+ * '<' = less than match expression
601
+ * '>' = greater than match expression
602
+ */
603
+ op: "=" | "<" | ">" | "!=";
604
+ };
605
+ /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
606
+ AggregateDimension: {
607
+ /** @description Input dimensions to the aggregate dimension */
608
+ inputs: external$4["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
609
+ };
610
+ /** @description Defines an input dimension to an aggregate dimension */
611
+ AggregateDimensionInput: {
612
+ /**
613
+ * @description Dimension name to reference as an input.
614
+ * For enrichment inputs, use CATEGORY_KEY as the dimension.
615
+ * Enrichments, signals, and other aggregate dimensions may be referenced.
616
+ *
617
+ * Note that creating a cycle of aggregate dimensions is allowed, however
618
+ * the final score will _ignore_ the cycled aggregate dimension in the result.
619
+ * This can be used to create mutually exclusive aggregates.
620
+ */
621
+ dim: string;
622
+ /**
623
+ * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
624
+ *
625
+ * '+' = add to the final score
626
+ * '-' = subtract from the final score
627
+ * 'c' = clear the final score (if the input dimension has any score at all, this aggreate will have no score regardless of other inputs)
628
+ *
629
+ * Default if unspecified: '+'
630
+ *
631
+ * @default +
632
+ */
633
+ sign?: "+" | "-" | "c";
634
+ };
635
+ Test: {
636
+ /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
637
+ wv?: string;
638
+ };
639
+ };
640
+ };
641
+ operations: {};
642
+ };
643
+ }
644
+
645
+ /**
646
+ * This file was auto-generated by openapi-typescript.
647
+ * Do not make direct changes to the file.
648
+ */
649
+ interface paths$3 {
650
+ "/api/v2/dimension": {
651
+ get: {
652
+ parameters: {
653
+ query: {
654
+ /** The project to fetch dimensions for */
655
+ projectId: string;
656
+ };
657
+ };
658
+ responses: {
659
+ /** OK */
660
+ 200: {
661
+ content: {
662
+ "application/json": {
663
+ dimensions: components$4["schemas"]["DimensionDefinition"][];
664
+ };
665
+ };
666
+ };
667
+ 400: external$3["swagger.yml"]["components"]["responses"]["BadRequestError"];
668
+ 401: external$3["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
669
+ 403: external$3["swagger.yml"]["components"]["responses"]["ForbiddenError"];
670
+ 429: external$3["swagger.yml"]["components"]["responses"]["RateLimitError"];
671
+ 500: external$3["swagger.yml"]["components"]["responses"]["InternalServerError"];
672
+ };
673
+ };
674
+ };
675
+ }
676
+ interface components$4 {
677
+ schemas: {
678
+ DimensionDefinition: {
679
+ /** @description The dimension name (score key) */
680
+ dim: string;
681
+ /**
682
+ * @description The dimension type
683
+ * AGG: Aggregation (intent or audience)
684
+ * ENR: Enrichment
685
+ * SIG: Signal
686
+ */
687
+ category: "AGG" | "ENR" | "SIG";
688
+ /**
689
+ * @description Subtype of the dimension
690
+ * AGG:0: Audience
691
+ * AGG:1: Intent
692
+ * ENR: Enrichment Category name
693
+ * SIG: null
694
+ */
695
+ subcategory?: string;
696
+ /** @description The dimension's name (without category) */
697
+ name: string;
698
+ /** @description The minimum score possible for the dimension */
699
+ min: number;
700
+ /** @description The maximum score possible for the dimension */
701
+ cap: number;
702
+ };
703
+ };
704
+ }
705
+ interface external$3 {
706
+ "swagger.yml": {
707
+ paths: {};
708
+ components: {
709
+ schemas: {
710
+ Error: {
711
+ /** @description Error message(s) that occurred while processing the request */
712
+ errorMessage?: string[] | string;
713
+ };
714
+ };
715
+ responses: {
716
+ /** Request input validation failed */
717
+ BadRequestError: {
718
+ content: {
719
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
720
+ };
721
+ };
722
+ /** API key or token was not valid */
723
+ UnauthorizedError: {
724
+ content: {
725
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
726
+ };
727
+ };
728
+ /** Permission was denied */
729
+ ForbiddenError: {
730
+ content: {
731
+ "application/json": external$3["swagger.yml"]["components"]["schemas"]["Error"];
732
+ };
733
+ };
734
+ /** Too many requests in allowed time period */
735
+ RateLimitError: unknown;
736
+ /** Execution error occurred */
737
+ InternalServerError: unknown;
738
+ };
739
+ };
740
+ operations: {};
741
+ };
742
+ }
743
+
744
+ /**
745
+ * This file was auto-generated by openapi-typescript.
746
+ * Do not make direct changes to the file.
747
+ */
748
+ interface paths$2 {
749
+ "/api/v2/quirk": {
750
+ /** Gets quirk definitions for a project */
751
+ get: {
752
+ parameters: {
753
+ query: {
754
+ /** The project to fetch quirk definitions for */
755
+ projectId: string;
756
+ /** Limit the results to a specific quirk ID */
757
+ quirkId?: string;
758
+ /** Include quirks that are defined by integrations */
759
+ withIntegrations?: boolean;
760
+ };
761
+ };
762
+ responses: {
763
+ /** OK */
764
+ 200: {
765
+ content: {
766
+ "application/json": {
767
+ quirks: components$3["schemas"]["Quirk"][];
768
+ };
769
+ };
770
+ };
771
+ 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
772
+ 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
773
+ 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
774
+ 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
775
+ 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
776
+ };
777
+ };
778
+ put: {
779
+ responses: {
780
+ /** OK */
781
+ 204: never;
782
+ 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
783
+ 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
784
+ 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
785
+ 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
786
+ 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
787
+ };
788
+ requestBody: {
789
+ content: {
790
+ "application/json": {
791
+ quirk: components$3["schemas"]["Quirk"];
792
+ /** Format: uuid */
793
+ projectId: string;
794
+ };
795
+ };
796
+ };
797
+ };
798
+ delete: {
799
+ responses: {
800
+ /** OK */
801
+ 204: never;
802
+ 400: external$2["swagger.yml"]["components"]["responses"]["BadRequestError"];
803
+ 401: external$2["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
804
+ 403: external$2["swagger.yml"]["components"]["responses"]["ForbiddenError"];
805
+ 429: external$2["swagger.yml"]["components"]["responses"]["RateLimitError"];
806
+ 500: external$2["swagger.yml"]["components"]["responses"]["InternalServerError"];
807
+ };
808
+ requestBody: {
809
+ content: {
810
+ "application/json": {
811
+ quirkId: string;
812
+ /** Format: uuid */
813
+ projectId: string;
814
+ };
815
+ };
816
+ };
817
+ };
818
+ };
819
+ }
820
+ interface components$3 {
821
+ schemas: {
822
+ Quirk: {
823
+ id: string;
824
+ name: string;
825
+ description?: string | null;
826
+ options?: components$3["schemas"]["QuirkOptions"][];
827
+ source?: components$3["schemas"]["QuirkSource"];
828
+ };
829
+ QuirkOptions: {
830
+ name: string;
831
+ value: string;
832
+ };
833
+ /** @description The source of this quirk. When not defined, it is user specified. */
834
+ QuirkSource: {
835
+ name: string;
836
+ id: string;
837
+ };
838
+ };
839
+ }
840
+ interface external$2 {
841
+ "swagger.yml": {
842
+ paths: {};
843
+ components: {
844
+ schemas: {
845
+ Error: {
846
+ /** @description Error message(s) that occurred while processing the request */
847
+ errorMessage?: string[] | string;
848
+ };
849
+ };
850
+ responses: {
851
+ /** Request input validation failed */
852
+ BadRequestError: {
853
+ content: {
854
+ "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
855
+ };
856
+ };
857
+ /** API key or token was not valid */
858
+ UnauthorizedError: {
859
+ content: {
860
+ "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
861
+ };
862
+ };
863
+ /** Permission was denied */
864
+ ForbiddenError: {
865
+ content: {
866
+ "application/json": external$2["swagger.yml"]["components"]["schemas"]["Error"];
867
+ };
868
+ };
869
+ /** Too many requests in allowed time period */
870
+ RateLimitError: unknown;
871
+ /** Execution error occurred */
872
+ InternalServerError: unknown;
873
+ };
874
+ };
875
+ operations: {};
876
+ };
877
+ }
878
+
879
+ /**
880
+ * This file was auto-generated by openapi-typescript.
881
+ * Do not make direct changes to the file.
882
+ */
883
+ interface paths$1 {
884
+ "/api/v2/test": {
885
+ /** Gets A/B test definitions for a project */
886
+ get: {
887
+ parameters: {
888
+ query: {
889
+ /** The project to fetch tests for */
890
+ projectId: string;
891
+ /** Limit the results to a specific test public ID */
892
+ testId?: string;
893
+ };
894
+ };
895
+ responses: {
896
+ /** OK */
897
+ 200: {
898
+ content: {
899
+ "application/json": {
900
+ tests: components$2["schemas"]["Test"][];
901
+ };
902
+ };
903
+ };
904
+ 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
905
+ 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
906
+ 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
907
+ 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
908
+ 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
909
+ };
910
+ };
911
+ put: {
912
+ responses: {
913
+ /** OK */
914
+ 204: never;
915
+ 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
916
+ 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
917
+ 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
918
+ 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
919
+ 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
920
+ };
921
+ requestBody: {
922
+ content: {
923
+ "application/json": {
924
+ test: components$2["schemas"]["Test"];
925
+ /** Format: uuid */
926
+ projectId: string;
927
+ };
928
+ };
929
+ };
930
+ };
931
+ delete: {
932
+ responses: {
933
+ /** OK */
934
+ 204: never;
935
+ 400: external$1["swagger.yml"]["components"]["responses"]["BadRequestError"];
936
+ 401: external$1["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
937
+ 403: external$1["swagger.yml"]["components"]["responses"]["ForbiddenError"];
938
+ 429: external$1["swagger.yml"]["components"]["responses"]["RateLimitError"];
939
+ 500: external$1["swagger.yml"]["components"]["responses"]["InternalServerError"];
940
+ };
941
+ requestBody: {
942
+ content: {
943
+ "application/json": {
944
+ testId: string;
945
+ /** Format: uuid */
946
+ projectId: string;
947
+ };
948
+ };
949
+ };
950
+ };
951
+ };
952
+ }
953
+ interface components$2 {
954
+ schemas: {
955
+ Test: {
956
+ id: string;
957
+ name: string;
958
+ winning_variant_id?: string;
959
+ default_variant_id?: string;
960
+ closed?: boolean;
961
+ };
962
+ };
963
+ }
964
+ interface external$1 {
965
+ "swagger.yml": {
966
+ paths: {};
967
+ components: {
968
+ schemas: {
969
+ Error: {
970
+ /** @description Error message(s) that occurred while processing the request */
971
+ errorMessage?: string[] | string;
972
+ };
973
+ };
974
+ responses: {
975
+ /** Request input validation failed */
976
+ BadRequestError: {
977
+ content: {
978
+ "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
979
+ };
980
+ };
981
+ /** API key or token was not valid */
982
+ UnauthorizedError: {
983
+ content: {
984
+ "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
985
+ };
986
+ };
987
+ /** Permission was denied */
988
+ ForbiddenError: {
989
+ content: {
990
+ "application/json": external$1["swagger.yml"]["components"]["schemas"]["Error"];
991
+ };
992
+ };
993
+ /** Too many requests in allowed time period */
994
+ RateLimitError: unknown;
995
+ /** Execution error occurred */
996
+ InternalServerError: unknown;
997
+ };
998
+ };
999
+ operations: {};
1000
+ };
1001
+ }
1002
+
1003
+ /**
1004
+ * This file was auto-generated by openapi-typescript.
1005
+ * Do not make direct changes to the file.
1006
+ */
1007
+ interface paths {
1008
+ "/api/v2/signal": {
1009
+ get: {
1010
+ parameters: {
1011
+ query: {
1012
+ /** The project to fetch signals for */
1013
+ projectId: string;
1014
+ /** Limit the results to a specific signal ID */
1015
+ signalId?: string;
1016
+ };
1017
+ };
1018
+ responses: {
1019
+ /** OK */
1020
+ 200: {
1021
+ content: {
1022
+ "application/json": {
1023
+ signals: components$1["schemas"]["SignalWithId"][];
1024
+ };
1025
+ };
1026
+ };
1027
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1028
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1029
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1030
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1031
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1032
+ };
1033
+ };
1034
+ put: {
1035
+ responses: {
1036
+ /** OK */
1037
+ 204: never;
1038
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1039
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1040
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1041
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1042
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1043
+ };
1044
+ requestBody: {
1045
+ content: {
1046
+ "application/json": {
1047
+ signal: components$1["schemas"]["SignalWithId"];
1048
+ /** Format: uuid */
1049
+ projectId: string;
1050
+ };
1051
+ };
1052
+ };
1053
+ };
1054
+ delete: {
1055
+ responses: {
1056
+ /** OK */
1057
+ 204: never;
1058
+ 400: external["swagger.yml"]["components"]["responses"]["BadRequestError"];
1059
+ 401: external["swagger.yml"]["components"]["responses"]["UnauthorizedError"];
1060
+ 403: external["swagger.yml"]["components"]["responses"]["ForbiddenError"];
1061
+ 429: external["swagger.yml"]["components"]["responses"]["RateLimitError"];
1062
+ 500: external["swagger.yml"]["components"]["responses"]["InternalServerError"];
1063
+ };
1064
+ requestBody: {
1065
+ content: {
1066
+ "application/json": {
1067
+ signalId: string;
1068
+ /** Format: uuid */
1069
+ projectId: string;
1070
+ };
1071
+ };
1072
+ };
1073
+ };
1074
+ };
1075
+ }
1076
+ interface components$1 {
1077
+ schemas: {
1078
+ SignalWithId: {
1079
+ id: string;
1080
+ } & external["uniform-context-types.swagger.yml"]["components"]["schemas"]["PreviewSignal"];
1081
+ };
1082
+ }
1083
+ interface external {
1084
+ "swagger.yml": {
1085
+ paths: {};
1086
+ components: {
1087
+ schemas: {
1088
+ Error: {
1089
+ /** @description Error message(s) that occurred while processing the request */
1090
+ errorMessage?: string[] | string;
1091
+ };
1092
+ };
1093
+ responses: {
1094
+ /** Request input validation failed */
1095
+ BadRequestError: {
1096
+ content: {
1097
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1098
+ };
1099
+ };
1100
+ /** API key or token was not valid */
1101
+ UnauthorizedError: {
1102
+ content: {
1103
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1104
+ };
1105
+ };
1106
+ /** Permission was denied */
1107
+ ForbiddenError: {
1108
+ content: {
1109
+ "application/json": external["swagger.yml"]["components"]["schemas"]["Error"];
1110
+ };
1111
+ };
1112
+ /** Too many requests in allowed time period */
1113
+ RateLimitError: unknown;
1114
+ /** Execution error occurred */
1115
+ InternalServerError: unknown;
1116
+ };
1117
+ };
1118
+ operations: {};
1119
+ };
1120
+ "uniform-context-types.swagger.yml": {
1121
+ paths: {};
1122
+ components: {
1123
+ schemas: {
1124
+ EnrichmentCategory: {
1125
+ /** @description The maximum visitor score allowed for enrichment keys in this category */
1126
+ cap: number;
1127
+ };
1128
+ PreviewSignal: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["Signal"] & {
1129
+ /** @description Friendly name of the signal */
1130
+ name: string;
1131
+ /** @description Description of the signal */
1132
+ description?: string;
1133
+ };
1134
+ Signal: {
1135
+ /** @description The signal strength per activation (each time its criteria are true, this score is added) */
1136
+ str: number;
1137
+ /** @description The maximum visitor score allowed for this signal */
1138
+ cap: number;
1139
+ /**
1140
+ * @description How long the signal's score should persist
1141
+ * 's' = current session (expires after a period of inactivity)
1142
+ * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
1143
+ * 't' = transient (score tracks the current state of the criteria every time scores are updated)
1144
+ */
1145
+ dur: "s" | "p" | "t";
1146
+ crit: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["RootSignalCriteriaGroup"];
1147
+ };
1148
+ RootSignalCriteriaGroup: {
1149
+ /** @description Criteria type (Group of other criteria) */
1150
+ type: "G";
1151
+ /**
1152
+ * @description The logical operator to apply to the criteria groups
1153
+ * & = AND
1154
+ * | = OR
1155
+ *
1156
+ * Default is `&` if unspecified.
1157
+ *
1158
+ * @default &
1159
+ */
1160
+ op?: "&" | "|";
1161
+ /** @description The criteria clauses that make up this grouping of criteria */
1162
+ clauses: (external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
1163
+ };
1164
+ SignalCriteriaGroup: {
1165
+ /** @description Criteria type (Group of other criteria) */
1166
+ type: "G";
1167
+ /**
1168
+ * @description The logical operator to apply to the criteria groups
1169
+ * & = AND
1170
+ * | = OR
1171
+ *
1172
+ * Default is `&` if unspecified.
1173
+ */
1174
+ op?: "&" | "|";
1175
+ /** @description The criteria clauses that make up this grouping of criteria */
1176
+ clauses: (external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteriaGroup"] | external["uniform-context-types.swagger.yml"]["components"]["schemas"]["SignalCriteria"])[];
1177
+ };
1178
+ 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"];
1179
+ /** @description Matches a URL query string parameter value */
1180
+ QueryStringCriteria: {
1181
+ type: "QS";
1182
+ /** @description The name of the query string parameter to match */
1183
+ queryName: string;
1184
+ /** @description The value to match the query string parameter against */
1185
+ match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1186
+ };
1187
+ /** @description Matches a web cookie value */
1188
+ CookieCriteria: {
1189
+ type: "CK";
1190
+ /** @description The name of the cookie to match */
1191
+ cookieName: string;
1192
+ /** @description The value to match the cookie against */
1193
+ match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1194
+ };
1195
+ /** @description Matches a visitor quirk key and value */
1196
+ QuirkCriteria: {
1197
+ type: "QK";
1198
+ /** @description The name of the quirk key to match */
1199
+ key: string;
1200
+ /** @description The quirk value to match against */
1201
+ match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1202
+ };
1203
+ /** @description Matches an analytics event name being fired */
1204
+ EventCriteria: {
1205
+ type: "EVT";
1206
+ /** @description How to match the event name */
1207
+ event: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1208
+ };
1209
+ /**
1210
+ * @description Matches the current page's absolute path (i.e. /path/to/page.html)
1211
+ * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
1212
+ */
1213
+ CurrentPageCriteria: {
1214
+ type: "PV";
1215
+ /** @description The page/route path to match as a page that has been visited */
1216
+ path: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["StringMatch"];
1217
+ };
1218
+ PageViewCountCriteria: {
1219
+ type: "PVC";
1220
+ /** @description The expression to match the page view count against */
1221
+ match: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["NumberMatch"];
1222
+ };
1223
+ /** @description Describes a match expression on a string */
1224
+ StringMatch: {
1225
+ /** @description The right hand side of the match expression */
1226
+ rhs: string;
1227
+ /**
1228
+ * @description The match operator
1229
+ * '=' = exact match
1230
+ * '~' = contains match
1231
+ * '//' = regular expression match
1232
+ *
1233
+ * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
1234
+ */
1235
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
1236
+ /** @description The case sensitivity of the match. Defaults to false if unspecified. */
1237
+ cs?: boolean;
1238
+ } | {
1239
+ /**
1240
+ * @description The type of match to perform
1241
+ * '*' = exists with any value
1242
+ * '!*' = does not exist
1243
+ */
1244
+ op: "*" | "!*";
1245
+ };
1246
+ /** @description Describes a match expression on a number */
1247
+ NumberMatch: {
1248
+ /** @description The right hand side of the match expression */
1249
+ rhs: number;
1250
+ /**
1251
+ * @description The type of match to perform
1252
+ * '=' = exact match
1253
+ * '!=' = not an exact match
1254
+ * '<' = less than match expression
1255
+ * '>' = greater than match expression
1256
+ */
1257
+ op: "=" | "<" | ">" | "!=";
1258
+ };
1259
+ /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
1260
+ AggregateDimension: {
1261
+ /** @description Input dimensions to the aggregate dimension */
1262
+ inputs: external["uniform-context-types.swagger.yml"]["components"]["schemas"]["AggregateDimensionInput"][];
1263
+ };
1264
+ /** @description Defines an input dimension to an aggregate dimension */
1265
+ AggregateDimensionInput: {
1266
+ /**
1267
+ * @description Dimension name to reference as an input.
1268
+ * For enrichment inputs, use CATEGORY_KEY as the dimension.
1269
+ * Enrichments, signals, and other aggregate dimensions may be referenced.
1270
+ *
1271
+ * Note that creating a cycle of aggregate dimensions is allowed, however
1272
+ * the final score will _ignore_ the cycled aggregate dimension in the result.
1273
+ * This can be used to create mutually exclusive aggregates.
1274
+ */
1275
+ dim: string;
1276
+ /**
1277
+ * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
1278
+ *
1279
+ * '+' = add to the final score
1280
+ * '-' = subtract from the final score
1281
+ * 'c' = clear the final score (if the input dimension has any score at all, this aggreate will have no score regardless of other inputs)
1282
+ *
1283
+ * Default if unspecified: '+'
1284
+ *
1285
+ * @default +
1286
+ */
1287
+ sign?: "+" | "-" | "c";
1288
+ };
1289
+ Test: {
1290
+ /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
1291
+ wv?: string;
1292
+ };
1293
+ };
1294
+ };
1295
+ operations: {};
1296
+ };
1297
+ }
1298
+
1299
+ interface components {
1300
+ schemas: {
1301
+ EnrichmentCategory: {
1302
+ /** @description The maximum visitor score allowed for enrichment keys in this category */
1303
+ cap: number;
1304
+ };
1305
+ PreviewSignal: components["schemas"]["Signal"] & {
1306
+ /** @description Friendly name of the signal */
1307
+ name: string;
1308
+ /** @description Description of the signal */
1309
+ description?: string;
1310
+ };
1311
+ Signal: {
1312
+ /** @description The signal strength per activation (each time its criteria are true, this score is added) */
1313
+ str: number;
1314
+ /** @description The maximum visitor score allowed for this signal */
1315
+ cap: number;
1316
+ /**
1317
+ * @description How long the signal's score should persist
1318
+ * 's' = current session (expires after a period of inactivity)
1319
+ * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
1320
+ * 't' = transient (score tracks the current state of the criteria every time scores are updated)
1321
+ */
1322
+ dur: "s" | "p" | "t";
1323
+ crit: components["schemas"]["RootSignalCriteriaGroup"];
1324
+ };
1325
+ RootSignalCriteriaGroup: {
1326
+ /** @description Criteria type (Group of other criteria) */
1327
+ type: "G";
1328
+ /**
1329
+ * @description The logical operator to apply to the criteria groups
1330
+ * & = AND
1331
+ * | = OR
1332
+ *
1333
+ * Default is `&` if unspecified.
1334
+ *
1335
+ * @default &
1336
+ */
1337
+ op?: "&" | "|";
1338
+ /** @description The criteria clauses that make up this grouping of criteria */
1339
+ clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
1340
+ };
1341
+ SignalCriteriaGroup: {
1342
+ /** @description Criteria type (Group of other criteria) */
1343
+ type: "G";
1344
+ /**
1345
+ * @description The logical operator to apply to the criteria groups
1346
+ * & = AND
1347
+ * | = OR
1348
+ *
1349
+ * Default is `&` if unspecified.
1350
+ */
1351
+ op?: "&" | "|";
1352
+ /** @description The criteria clauses that make up this grouping of criteria */
1353
+ clauses: (components["schemas"]["SignalCriteriaGroup"] | components["schemas"]["SignalCriteria"])[];
1354
+ };
1355
+ SignalCriteria: components["schemas"]["CookieCriteria"] | components["schemas"]["QueryStringCriteria"] | components["schemas"]["QuirkCriteria"] | components["schemas"]["EventCriteria"] | components["schemas"]["CurrentPageCriteria"] | components["schemas"]["PageViewCountCriteria"];
1356
+ /** @description Matches a URL query string parameter value */
1357
+ QueryStringCriteria: {
1358
+ type: "QS";
1359
+ /** @description The name of the query string parameter to match */
1360
+ queryName: string;
1361
+ /** @description The value to match the query string parameter against */
1362
+ match: components["schemas"]["StringMatch"];
1363
+ };
1364
+ /** @description Matches a web cookie value */
1365
+ CookieCriteria: {
1366
+ type: "CK";
1367
+ /** @description The name of the cookie to match */
1368
+ cookieName: string;
1369
+ /** @description The value to match the cookie against */
1370
+ match: components["schemas"]["StringMatch"];
1371
+ };
1372
+ /** @description Matches a visitor quirk key and value */
1373
+ QuirkCriteria: {
1374
+ type: "QK";
1375
+ /** @description The name of the quirk key to match */
1376
+ key: string;
1377
+ /** @description The quirk value to match against */
1378
+ match: components["schemas"]["StringMatch"];
1379
+ };
1380
+ /** @description Matches an analytics event name being fired */
1381
+ EventCriteria: {
1382
+ type: "EVT";
1383
+ /** @description How to match the event name */
1384
+ event: components["schemas"]["StringMatch"];
1385
+ };
1386
+ /**
1387
+ * @description Matches the current page's absolute path (i.e. /path/to/page.html)
1388
+ * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
1389
+ */
1390
+ CurrentPageCriteria: {
1391
+ type: "PV";
1392
+ /** @description The page/route path to match as a page that has been visited */
1393
+ path: components["schemas"]["StringMatch"];
1394
+ };
1395
+ PageViewCountCriteria: {
1396
+ type: "PVC";
1397
+ /** @description The expression to match the page view count against */
1398
+ match: components["schemas"]["NumberMatch"];
1399
+ };
1400
+ /** @description Describes a match expression on a string */
1401
+ StringMatch: {
1402
+ /** @description The right hand side of the match expression */
1403
+ rhs: string;
1404
+ /**
1405
+ * @description The match operator
1406
+ * '=' = exact match
1407
+ * '~' = contains match
1408
+ * '//' = regular expression match
1409
+ *
1410
+ * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
1411
+ */
1412
+ op: "=" | "~" | "//" | "!=" | "!~" | "!//";
1413
+ /** @description The case sensitivity of the match. Defaults to false if unspecified. */
1414
+ cs?: boolean;
1415
+ } | {
1416
+ /**
1417
+ * @description The type of match to perform
1418
+ * '*' = exists with any value
1419
+ * '!*' = does not exist
1420
+ */
1421
+ op: "*" | "!*";
1422
+ };
1423
+ /** @description Describes a match expression on a number */
1424
+ NumberMatch: {
1425
+ /** @description The right hand side of the match expression */
1426
+ rhs: number;
1427
+ /**
1428
+ * @description The type of match to perform
1429
+ * '=' = exact match
1430
+ * '!=' = not an exact match
1431
+ * '<' = less than match expression
1432
+ * '>' = greater than match expression
1433
+ */
1434
+ op: "=" | "<" | ">" | "!=";
1435
+ };
1436
+ /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience. */
1437
+ AggregateDimension: {
1438
+ /** @description Input dimensions to the aggregate dimension */
1439
+ inputs: components["schemas"]["AggregateDimensionInput"][];
1440
+ };
1441
+ /** @description Defines an input dimension to an aggregate dimension */
1442
+ AggregateDimensionInput: {
1443
+ /**
1444
+ * @description Dimension name to reference as an input.
1445
+ * For enrichment inputs, use CATEGORY_KEY as the dimension.
1446
+ * Enrichments, signals, and other aggregate dimensions may be referenced.
1447
+ *
1448
+ * Note that creating a cycle of aggregate dimensions is allowed, however
1449
+ * the final score will _ignore_ the cycled aggregate dimension in the result.
1450
+ * This can be used to create mutually exclusive aggregates.
1451
+ */
1452
+ dim: string;
1453
+ /**
1454
+ * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
1455
+ *
1456
+ * '+' = add to the final score
1457
+ * '-' = subtract from the final score
1458
+ * 'c' = clear the final score (if the input dimension has any score at all, this aggreate will have no score regardless of other inputs)
1459
+ *
1460
+ * Default if unspecified: '+'
1461
+ *
1462
+ * @default +
1463
+ */
1464
+ sign?: "+" | "-" | "c";
1465
+ };
1466
+ Test: {
1467
+ /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
1468
+ wv?: string;
1469
+ };
1470
+ };
1471
+ }
1472
+
1473
+ declare type EnrichmentGet = paths$6['/api/v1/enrichments']['get'];
1474
+ declare type EnrichmentGetParameters = EnrichmentGet['parameters']['query'];
1475
+ declare type EnrichmentGetResponse = EnrichmentGet['responses']['200']['content']['application/json'];
1476
+ declare type EnrichmentCategory = components$6['schemas']['EnrichmentCategory'];
1477
+ declare type EnrichmentCategoryWithValues = components$6['schemas']['EnrichmentCategoryWithValues'];
1478
+ declare type EnrichmentValue = components$6['schemas']['EnrichmentValue'];
1479
+ declare type EnrichmentPut = paths$6['/api/v1/enrichments']['put'];
1480
+ declare type EnrichmentPutParameters = EnrichmentPut['requestBody']['content']['application/json'];
1481
+ declare type EnrichmentDelete = paths$6['/api/v1/enrichments']['delete'];
1482
+ declare type EnrichmentDeleteParameters = EnrichmentDelete['requestBody']['content']['application/json'];
1483
+ declare type EnrichmentValuePut = paths$5['/api/v1/enrichment-values']['put'];
1484
+ declare type EnrichmentValuePutParameters = EnrichmentValuePut['requestBody']['content']['application/json'];
1485
+ declare type EnrichmentValueDelete = paths$5['/api/v1/enrichment-values']['delete'];
1486
+ declare type EnrichmentValueDeleteParameters = EnrichmentValueDelete['requestBody']['content']['application/json'];
1487
+ declare type ManifestGet = paths$7['/api/v2/manifest']['get'];
1488
+ declare type ManifestGetParameters = ManifestGet['parameters']['query'];
1489
+ declare type ManifestGetResponse = ManifestGet['responses']['200']['content']['application/json'];
1490
+ declare type AggregateGet = paths$4['/api/v2/aggregate']['get'];
1491
+ declare type AggregateGetParameters = AggregateGet['parameters']['query'];
1492
+ declare type AggregateGetResponse = AggregateGet['responses']['200']['content']['application/json'];
1493
+ declare type Aggregate = components$5['schemas']['AggregateData'];
1494
+ declare type AggregatePut = paths$4['/api/v2/aggregate']['put'];
1495
+ declare type AggregatePutParameters = AggregatePut['requestBody']['content']['application/json'];
1496
+ declare type AggregateDelete = paths$4['/api/v2/aggregate']['delete'];
1497
+ declare type AggregateDeleteParameters = AggregateDelete['requestBody']['content']['application/json'];
1498
+ declare type DimensionGet = paths$3['/api/v2/dimension']['get'];
1499
+ declare type DimensionGetParameters = DimensionGet['parameters']['query'];
1500
+ declare type DimensionGetResponse = DimensionGet['responses']['200']['content']['application/json'];
1501
+ declare type DimensionDefinition = components$4['schemas']['DimensionDefinition'];
1502
+ declare type QuirkGet = paths$2['/api/v2/quirk']['get'];
1503
+ declare type QuirkGetParameters = QuirkGet['parameters']['query'];
1504
+ declare type QuirkGetResponse = QuirkGet['responses']['200']['content']['application/json'];
1505
+ declare type Quirk = components$3['schemas']['Quirk'];
1506
+ declare type QuirkPut = paths$2['/api/v2/quirk']['put'];
1507
+ declare type QuirkPutParameters = QuirkPut['requestBody']['content']['application/json'];
1508
+ declare type QuirkDelete = paths$2['/api/v2/quirk']['delete'];
1509
+ declare type QuirkDeleteParameters = QuirkDelete['requestBody']['content']['application/json'];
1510
+ declare type TestGet = paths$1['/api/v2/test']['get'];
1511
+ declare type TestGetParameters = TestGet['parameters']['query'];
1512
+ declare type TestGetResponse = TestGet['responses']['200']['content']['application/json'];
1513
+ declare type Test = components$2['schemas']['Test'];
1514
+ declare type TestPut = paths$1['/api/v2/test']['put'];
1515
+ declare type TestPutParameters = TestPut['requestBody']['content']['application/json'];
1516
+ declare type TestDelete = paths$1['/api/v2/test']['delete'];
1517
+ declare type TestDeleteParameters = TestDelete['requestBody']['content']['application/json'];
1518
+ declare type SignalGet = paths['/api/v2/signal']['get'];
1519
+ declare type SignalGetParameters = SignalGet['parameters']['query'];
1520
+ declare type SignalGetResponse = SignalGet['responses']['200']['content']['application/json'];
1521
+ declare type SignalWithId = components$1['schemas']['SignalWithId'];
1522
+ declare type RootSignalCriteriaGroup = components['schemas']['RootSignalCriteriaGroup'];
1523
+ declare type CookieCriteria = components['schemas']['CookieCriteria'];
1524
+ declare type QueryStringCriteria = components['schemas']['QueryStringCriteria'];
1525
+ declare type QuirkCriteria = components['schemas']['QuirkCriteria'];
1526
+ declare type EventCriteria = components['schemas']['EventCriteria'];
1527
+ declare type CurrentPageCriteria = components['schemas']['CurrentPageCriteria'];
1528
+ declare type PageViewCountCriteria = components['schemas']['PageViewCountCriteria'];
1529
+ declare type SignalPut = paths['/api/v2/signal']['put'];
1530
+ declare type SignalPutParameters = SignalPut['requestBody']['content']['application/json'];
1531
+ declare type SignalDelete = paths['/api/v2/signal']['delete'];
1532
+ declare type SignalDeleteParameters = SignalDelete['requestBody']['content']['application/json'];
1533
+
1534
+ export { Aggregate as A, EnrichmentValue as B, CookieCriteria as C, DimensionGetParameters as D, EnrichmentCategoryWithValues as E, QueryStringCriteria as F, QuirkCriteria as G, EventCriteria as H, CurrentPageCriteria as I, ManifestGetParameters as M, PageViewCountCriteria as P, Quirk as Q, RootSignalCriteriaGroup as R, SignalWithId as S, Test as T, AggregateGetParameters as a, AggregateGetResponse as b, AggregatePutParameters as c, AggregateDeleteParameters as d, DimensionGetResponse as e, EnrichmentGetParameters as f, EnrichmentGetResponse as g, EnrichmentPutParameters as h, EnrichmentDeleteParameters as i, EnrichmentValuePutParameters as j, EnrichmentValueDeleteParameters as k, ManifestGetResponse as l, QuirkGetParameters as m, QuirkGetResponse as n, QuirkPutParameters as o, QuirkDeleteParameters as p, SignalGetParameters as q, SignalGetResponse as r, SignalPutParameters as s, SignalDeleteParameters as t, TestGetParameters as u, TestGetResponse as v, TestPutParameters as w, TestDeleteParameters as x, DimensionDefinition as y, EnrichmentCategory as z };