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