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