@uniformdev/context 20.75.1-alpha.16 → 20.76.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.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { p as paths$7, M as ManifestV2 } from '../types-C0Mthca3.js';
1
+ import { p as paths$7, M as ManifestV2 } from '../types-DovaM4gV.js';
2
2
  import 'mitt';
3
3
 
4
4
  type LimitPolicy = <ReturnValue>(func: () => Promise<ReturnValue>) => Promise<ReturnValue>;
@@ -72,26 +72,26 @@ declare function rewriteFiltersForApi(filters?: Record<string, unknown>): Record
72
72
  interface components$7 {
73
73
  schemas: {
74
74
  EnrichmentCategory: {
75
- /** @description The maximum visitor score allowed for enrichment keys in this category */
75
+ /** The maximum visitor score allowed for enrichment keys in this category */
76
76
  cap: number;
77
77
  };
78
78
  PreviewSignal: components$7["schemas"]["Signal"] & {
79
- /** @description Friendly name of the signal */
79
+ /** Friendly name of the signal */
80
80
  name: string;
81
- /** @description Description of the signal */
81
+ /** Description of the signal */
82
82
  description?: string;
83
83
  };
84
84
  Signal: {
85
- /** @description The signal strength per activation (each time its criteria are true, this score is added) */
85
+ /** The signal strength per activation (each time its criteria are true, this score is added) */
86
86
  str: number;
87
- /** @description The maximum visitor score allowed for this signal */
87
+ /** The maximum visitor score allowed for this signal */
88
88
  cap: number;
89
89
  /**
90
- * @description How long the signal's score should persist
90
+ * How long the signal's score should persist
91
91
  * 's' = current session (expires after a period of inactivity)
92
92
  * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
93
93
  * 't' = transient (score tracks the current state of the criteria every time scores are updated)
94
- * @enum {string}
94
+
95
95
  */
96
96
  dur: "s" | "p" | "t";
97
97
  crit: components$7["schemas"]["RootSignalCriteriaGroup"];
@@ -99,147 +99,147 @@ interface components$7 {
99
99
  };
100
100
  RootSignalCriteriaGroup: {
101
101
  /**
102
- * @description Criteria type (Group of other criteria)
103
- * @enum {string}
102
+ * Criteria type (Group of other criteria)
103
+
104
104
  */
105
105
  type: "G";
106
106
  /**
107
- * @description The logical operator to apply to the criteria groups
107
+ * The logical operator to apply to the criteria groups
108
108
  * & = AND
109
109
  * | = OR
110
110
  *
111
111
  * Default is `&` if unspecified
112
- * @default &
113
- * @enum {string}
112
+ * @defaultValue &
113
+
114
114
  */
115
115
  op?: "&" | "|";
116
- /** @description The criteria clauses that make up this grouping of criteria */
116
+ /** The criteria clauses that make up this grouping of criteria */
117
117
  clauses: (components$7["schemas"]["SignalCriteriaGroup"] | components$7["schemas"]["SignalCriteria"])[];
118
118
  };
119
119
  Conversion: {
120
120
  /**
121
- * @description The frequency of the conversion event
122
- * @enum {string}
121
+ * The frequency of the conversion event
122
+
123
123
  */
124
124
  freq: "O";
125
125
  };
126
126
  SignalCriteriaGroup: {
127
127
  /**
128
- * @description Criteria type (Group of other criteria)
129
- * @enum {string}
128
+ * Criteria type (Group of other criteria)
129
+
130
130
  */
131
131
  type: "G";
132
132
  /**
133
- * @description The logical operator to apply to the criteria groups
133
+ * The logical operator to apply to the criteria groups
134
134
  * & = AND
135
135
  * | = OR
136
136
  *
137
137
  * Default is `&` if unspecified
138
- * @enum {string}
138
+
139
139
  */
140
140
  op?: "&" | "|";
141
- /** @description The criteria clauses that make up this grouping of criteria */
141
+ /** The criteria clauses that make up this grouping of criteria */
142
142
  clauses: (components$7["schemas"]["SignalCriteriaGroup"] | components$7["schemas"]["SignalCriteria"])[];
143
143
  };
144
144
  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"];
145
- /** @description Matches a URL query string parameter value */
145
+ /** Matches a URL query string parameter value */
146
146
  QueryStringCriteria: {
147
147
  /** @enum {string} */
148
148
  type: "QS";
149
- /** @description The name of the query string parameter to match */
149
+ /** The name of the query string parameter to match */
150
150
  queryName: string;
151
- /** @description The value to match the query string parameter against */
151
+ /** The value to match the query string parameter against */
152
152
  match: components$7["schemas"]["StringMatch"];
153
153
  };
154
- /** @description Matches a web cookie value */
154
+ /** Matches a web cookie value */
155
155
  CookieCriteria: {
156
156
  /** @enum {string} */
157
157
  type: "CK";
158
- /** @description The name of the cookie to match */
158
+ /** The name of the cookie to match */
159
159
  cookieName: string;
160
- /** @description The value to match the cookie against */
160
+ /** The value to match the cookie against */
161
161
  match: components$7["schemas"]["StringMatch"];
162
162
  };
163
- /** @description Matches a visitor quirk key and value */
163
+ /** Matches a visitor quirk key and value */
164
164
  QuirkCriteria: {
165
165
  /** @enum {string} */
166
166
  type: "QK";
167
- /** @description The name of the quirk key to match */
167
+ /** The name of the quirk key to match */
168
168
  key: string;
169
- /** @description The quirk value to match against */
169
+ /** The quirk value to match against */
170
170
  match: components$7["schemas"]["StringMatch"];
171
171
  };
172
- /** @description Matches an analytics event name being fired */
172
+ /** Matches an analytics event name being fired */
173
173
  EventCriteria: {
174
174
  /** @enum {string} */
175
175
  type: "EVT";
176
- /** @description How to match the event name */
176
+ /** How to match the event name */
177
177
  event: components$7["schemas"]["StringMatch"];
178
178
  };
179
179
  /**
180
- * @description Matches the current page's absolute path (i.e. /path/to/page.html)
180
+ * Matches the current page's absolute path (i.e. /path/to/page.html)
181
181
  * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
182
182
  */
183
183
  CurrentPageCriteria: {
184
184
  /** @enum {string} */
185
185
  type: "PV";
186
- /** @description The page/route path to match as a page that has been visited */
186
+ /** The page/route path to match as a page that has been visited */
187
187
  path: components$7["schemas"]["StringMatch"];
188
188
  };
189
189
  PageViewCountCriteria: {
190
190
  /** @enum {string} */
191
191
  type: "PVC";
192
- /** @description The expression to match the page view count against */
192
+ /** The expression to match the page view count against */
193
193
  match: components$7["schemas"]["NumberMatch"];
194
194
  };
195
- /** @description Describes a match expression on a string */
195
+ /** Describes a match expression on a string */
196
196
  StringMatch: {
197
- /** @description The right-hand side of the match expression */
197
+ /** The right-hand side of the match expression */
198
198
  rhs: string;
199
199
  /**
200
- * @description The match operator
200
+ * The match operator
201
201
  * '=' = exact match
202
202
  * '~' = contains match
203
203
  * '//' = regular expression match
204
204
  *
205
205
  * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
206
- * @enum {string}
206
+
207
207
  */
208
208
  op: "=" | "~" | "//" | "!=" | "!~" | "!//";
209
- /** @description The case sensitivity of the match. Defaults to false if unspecified */
209
+ /** The case sensitivity of the match. Defaults to false if unspecified */
210
210
  cs?: boolean;
211
211
  } | {
212
212
  /**
213
- * @description The type of match to perform
213
+ * The type of match to perform
214
214
  * '*' = exists with any value
215
215
  * '!*' = does not exist
216
- * @enum {string}
216
+
217
217
  */
218
218
  op: "*" | "!*";
219
219
  };
220
- /** @description Describes a match expression on a number */
220
+ /** Describes a match expression on a number */
221
221
  NumberMatch: {
222
- /** @description The right-hand side of the match expression */
222
+ /** The right-hand side of the match expression */
223
223
  rhs: number;
224
224
  /**
225
- * @description The type of match to perform
225
+ * The type of match to perform
226
226
  * '=' = exact match
227
227
  * '!=' = not an exact match
228
228
  * '<' = less than match expression
229
229
  * '>' = greater than match expression
230
- * @enum {string}
230
+
231
231
  */
232
232
  op: "=" | "<" | ">" | "!=";
233
233
  };
234
- /** @description Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
234
+ /** Defines an aggregate dimension that is a grouping of other dimensions' scores; an intent or audience */
235
235
  AggregateDimension: {
236
- /** @description Input dimensions to the aggregate dimension */
236
+ /** Input dimensions to the aggregate dimension */
237
237
  inputs: components$7["schemas"]["AggregateDimensionInput"][];
238
238
  };
239
- /** @description Defines an input dimension to an aggregate dimension */
239
+ /** Defines an input dimension to an aggregate dimension */
240
240
  AggregateDimensionInput: {
241
241
  /**
242
- * @description Dimension name to reference as an input.
242
+ * Dimension name to reference as an input.
243
243
  * For enrichment inputs, use CATEGORY_KEY as the dimension.
244
244
  * Enrichments, signals, and other aggregate dimensions may be referenced.
245
245
  *
@@ -249,20 +249,20 @@ interface components$7 {
249
249
  */
250
250
  dim: string;
251
251
  /**
252
- * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
252
+ * The sign of the input dimension controls how it affects the aggregate dimension's final score.
253
253
  *
254
254
  * '+' = add to the final score
255
255
  * '-' = subtract from the final score
256
256
  * 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
257
257
  *
258
258
  * Default if unspecified: '+'
259
- * @default +
260
- * @enum {string}
259
+ * @defaultValue +
260
+
261
261
  */
262
262
  sign?: "+" | "-" | "c";
263
263
  };
264
264
  Test: {
265
- /** @description Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
265
+ /** Winning variation ID - if set, the test will not run and this variation is shown to all visitors (the test is closed) */
266
266
  wv?: string;
267
267
  };
268
268
  };
@@ -300,7 +300,7 @@ interface paths$6 {
300
300
  };
301
301
  };
302
302
  responses: {
303
- /** @description OK */
303
+ /** OK */
304
304
  204: {
305
305
  headers: {
306
306
  [name: string]: unknown;
@@ -333,7 +333,7 @@ interface paths$6 {
333
333
  };
334
334
  };
335
335
  responses: {
336
- /** @description OK */
336
+ /** OK */
337
337
  204: {
338
338
  headers: {
339
339
  [name: string]: unknown;
@@ -343,7 +343,7 @@ interface paths$6 {
343
343
  400: components$6["responses"]["BadRequestError"];
344
344
  401: components$6["responses"]["UnauthorizedError"];
345
345
  403: components$6["responses"]["ForbiddenError"];
346
- /** @description Parent enrichment category was not found */
346
+ /** Parent enrichment category was not found */
347
347
  404: {
348
348
  headers: {
349
349
  [name: string]: unknown;
@@ -354,7 +354,7 @@ interface paths$6 {
354
354
  500: components$6["responses"]["InternalServerError"];
355
355
  };
356
356
  };
357
- /** @description Handles preflight requests. This endpoint allows CORS. */
357
+ /** Handles preflight requests. This endpoint allows CORS. */
358
358
  options: {
359
359
  parameters: {
360
360
  query?: never;
@@ -364,7 +364,7 @@ interface paths$6 {
364
364
  };
365
365
  requestBody?: never;
366
366
  responses: {
367
- /** @description OK */
367
+ /** OK */
368
368
  204: {
369
369
  headers: {
370
370
  [name: string]: unknown;
@@ -381,20 +381,20 @@ interface paths$6 {
381
381
  interface components$6 {
382
382
  schemas: {
383
383
  EnrichmentValue: {
384
- /** @description Public ID of the enrichment value */
384
+ /** Public ID of the enrichment value */
385
385
  id: string;
386
- /** @description Display name of the enrichment value */
386
+ /** Display name of the enrichment value */
387
387
  value: string;
388
- /** @description Optional sort order of the enrichment value (if not set, sorts by name) */
388
+ /** Optional sort order of the enrichment value (if not set, sorts by name) */
389
389
  sortOrder?: number | null;
390
390
  };
391
391
  Error: {
392
- /** @description Error message(s) that occurred while processing the request */
392
+ /** Error message(s) that occurred while processing the request */
393
393
  errorMessage?: string[] | string;
394
394
  };
395
395
  };
396
396
  responses: {
397
- /** @description Request input validation failed */
397
+ /** Request input validation failed */
398
398
  BadRequestError: {
399
399
  headers: {
400
400
  [name: string]: unknown;
@@ -403,7 +403,7 @@ interface components$6 {
403
403
  "application/json": components$6["schemas"]["Error"];
404
404
  };
405
405
  };
406
- /** @description API key or token was not valid */
406
+ /** API key or token was not valid */
407
407
  UnauthorizedError: {
408
408
  headers: {
409
409
  [name: string]: unknown;
@@ -412,7 +412,7 @@ interface components$6 {
412
412
  "application/json": components$6["schemas"]["Error"];
413
413
  };
414
414
  };
415
- /** @description Permission was denied */
415
+ /** Permission was denied */
416
416
  ForbiddenError: {
417
417
  headers: {
418
418
  [name: string]: unknown;
@@ -421,14 +421,14 @@ interface components$6 {
421
421
  "application/json": components$6["schemas"]["Error"];
422
422
  };
423
423
  };
424
- /** @description Too many requests in allowed time period */
424
+ /** Too many requests in allowed time period */
425
425
  RateLimitError: {
426
426
  headers: {
427
427
  [name: string]: unknown;
428
428
  };
429
429
  content?: never;
430
430
  };
431
- /** @description Execution error occurred */
431
+ /** Execution error occurred */
432
432
  InternalServerError: {
433
433
  headers: {
434
434
  [name: string]: unknown;
@@ -461,7 +461,7 @@ interface paths$5 {
461
461
  };
462
462
  requestBody?: never;
463
463
  responses: {
464
- /** @description OK */
464
+ /** OK */
465
465
  200: {
466
466
  headers: {
467
467
  [name: string]: unknown;
@@ -496,7 +496,7 @@ interface paths$5 {
496
496
  };
497
497
  };
498
498
  responses: {
499
- /** @description OK */
499
+ /** OK */
500
500
  204: {
501
501
  headers: {
502
502
  [name: string]: unknown;
@@ -528,7 +528,7 @@ interface paths$5 {
528
528
  };
529
529
  };
530
530
  responses: {
531
- /** @description OK */
531
+ /** OK */
532
532
  204: {
533
533
  headers: {
534
534
  [name: string]: unknown;
@@ -542,7 +542,7 @@ interface paths$5 {
542
542
  500: components$5["responses"]["InternalServerError"];
543
543
  };
544
544
  };
545
- /** @description Handles preflight requests. This endpoint allows CORS. */
545
+ /** Handles preflight requests. This endpoint allows CORS. */
546
546
  options: {
547
547
  parameters: {
548
548
  query?: never;
@@ -552,7 +552,7 @@ interface paths$5 {
552
552
  };
553
553
  requestBody?: never;
554
554
  responses: {
555
- /** @description OK */
555
+ /** OK */
556
556
  204: {
557
557
  headers: {
558
558
  [name: string]: unknown;
@@ -569,15 +569,15 @@ interface paths$5 {
569
569
  interface components$5 {
570
570
  schemas: {
571
571
  EnrichmentCategory: {
572
- /** @description Public ID of the enrichment category */
572
+ /** Public ID of the enrichment category */
573
573
  id: string;
574
- /** @description Display name of the enrichment category */
574
+ /** Display name of the enrichment category */
575
575
  name: string;
576
- /** @description Optional sort order of the enrichment category (if not set, sorts by name) */
576
+ /** Optional sort order of the enrichment category (if not set, sorts by name) */
577
577
  sortOrder?: number | null;
578
578
  /**
579
- * @description The maximum visitor score allowed for enrichment keys in this category
580
- * @default 99999999
579
+ * The maximum visitor score allowed for enrichment keys in this category
580
+ * @defaultValue 99999999
581
581
  */
582
582
  cap?: number;
583
583
  };
@@ -585,20 +585,20 @@ interface components$5 {
585
585
  values: components$5["schemas"]["EnrichmentValue"][];
586
586
  };
587
587
  EnrichmentValue: {
588
- /** @description Public ID of the enrichment value */
588
+ /** Public ID of the enrichment value */
589
589
  id: string;
590
- /** @description Display name of the enrichment value */
590
+ /** Display name of the enrichment value */
591
591
  value: string;
592
- /** @description Optional sort order of the enrichment value (if not set, sorts by name) */
592
+ /** Optional sort order of the enrichment value (if not set, sorts by name) */
593
593
  sortOrder?: number | null;
594
594
  };
595
595
  Error: {
596
- /** @description Error message(s) that occurred while processing the request */
596
+ /** Error message(s) that occurred while processing the request */
597
597
  errorMessage?: string[] | string;
598
598
  };
599
599
  };
600
600
  responses: {
601
- /** @description Request input validation failed */
601
+ /** Request input validation failed */
602
602
  BadRequestError: {
603
603
  headers: {
604
604
  [name: string]: unknown;
@@ -607,7 +607,7 @@ interface components$5 {
607
607
  "application/json": components$5["schemas"]["Error"];
608
608
  };
609
609
  };
610
- /** @description API key or token was not valid */
610
+ /** API key or token was not valid */
611
611
  UnauthorizedError: {
612
612
  headers: {
613
613
  [name: string]: unknown;
@@ -616,7 +616,7 @@ interface components$5 {
616
616
  "application/json": components$5["schemas"]["Error"];
617
617
  };
618
618
  };
619
- /** @description Permission was denied */
619
+ /** Permission was denied */
620
620
  ForbiddenError: {
621
621
  headers: {
622
622
  [name: string]: unknown;
@@ -625,14 +625,14 @@ interface components$5 {
625
625
  "application/json": components$5["schemas"]["Error"];
626
626
  };
627
627
  };
628
- /** @description Too many requests in allowed time period */
628
+ /** Too many requests in allowed time period */
629
629
  RateLimitError: {
630
630
  headers: {
631
631
  [name: string]: unknown;
632
632
  };
633
633
  content?: never;
634
634
  };
635
- /** @description Execution error occurred */
635
+ /** Execution error occurred */
636
636
  InternalServerError: {
637
637
  headers: {
638
638
  [name: string]: unknown;
@@ -657,12 +657,12 @@ interface paths$4 {
657
657
  get: {
658
658
  parameters: {
659
659
  query: {
660
- /** @description The project to fetch aggregates for */
660
+ /** The project to fetch aggregates for */
661
661
  projectId: string;
662
- /** @description Limit the results to a specific aggregate ID */
662
+ /** Limit the results to a specific aggregate ID */
663
663
  aggregateId?: string;
664
664
  /**
665
- * @description Limit the results to a specific aggregate type
665
+ * Limit the results to a specific aggregate type
666
666
  * 0: Audience
667
667
  * 1: Intent
668
668
  */
@@ -674,7 +674,7 @@ interface paths$4 {
674
674
  };
675
675
  requestBody?: never;
676
676
  responses: {
677
- /** @description OK */
677
+ /** OK */
678
678
  200: {
679
679
  headers: {
680
680
  [name: string]: unknown;
@@ -706,17 +706,17 @@ interface paths$4 {
706
706
  /** Format: uuid */
707
707
  projectId: string;
708
708
  /**
709
- * @description Skips updating aggregate inputs and upserts only the aggregate definition.
709
+ * Skips updating aggregate inputs and upserts only the aggregate definition.
710
710
  * Inputs data is still required, but is ignored and not saved or validated.
711
711
  * Useful when creating aggregates that reference each other: Create the definitions, then the inputs.
712
- * @default false
712
+ * @defaultValue false
713
713
  */
714
714
  skipInputs?: boolean;
715
715
  };
716
716
  };
717
717
  };
718
718
  responses: {
719
- /** @description OK */
719
+ /** OK */
720
720
  204: {
721
721
  headers: {
722
722
  [name: string]: unknown;
@@ -748,7 +748,7 @@ interface paths$4 {
748
748
  };
749
749
  };
750
750
  responses: {
751
- /** @description OK */
751
+ /** OK */
752
752
  204: {
753
753
  headers: {
754
754
  [name: string]: unknown;
@@ -762,7 +762,7 @@ interface paths$4 {
762
762
  500: components$4["responses"]["InternalServerError"];
763
763
  };
764
764
  };
765
- /** @description Handles preflight requests. This endpoint allows CORS. */
765
+ /** Handles preflight requests. This endpoint allows CORS. */
766
766
  options: {
767
767
  parameters: {
768
768
  query?: never;
@@ -772,7 +772,7 @@ interface paths$4 {
772
772
  };
773
773
  requestBody?: never;
774
774
  responses: {
775
- /** @description OK */
775
+ /** OK */
776
776
  204: {
777
777
  headers: {
778
778
  [name: string]: unknown;
@@ -793,18 +793,18 @@ interface components$4 {
793
793
  name: string;
794
794
  description?: string;
795
795
  /**
796
- * @description The type of aggregate
796
+ * The type of aggregate
797
797
  * 0: Audience
798
798
  * 1: Intent
799
- * @enum {number}
799
+
800
800
  */
801
801
  type: 0 | 1;
802
802
  inputs: components$4["schemas"]["AggregateDimensionInput"][];
803
803
  };
804
- /** @description Defines an input dimension to an aggregate dimension */
804
+ /** Defines an input dimension to an aggregate dimension */
805
805
  AggregateDimensionInput: {
806
806
  /**
807
- * @description Dimension name to reference as an input.
807
+ * Dimension name to reference as an input.
808
808
  * For enrichment inputs, use CATEGORY_KEY as the dimension.
809
809
  * Enrichments, signals, and other aggregate dimensions may be referenced.
810
810
  *
@@ -814,25 +814,25 @@ interface components$4 {
814
814
  */
815
815
  dim: string;
816
816
  /**
817
- * @description The sign of the input dimension controls how it affects the aggregate dimension's final score.
817
+ * The sign of the input dimension controls how it affects the aggregate dimension's final score.
818
818
  *
819
819
  * '+' = add to the final score
820
820
  * '-' = subtract from the final score
821
821
  * 'c' = clear the final score (if the input dimension has any score at all, this aggregate will have no score regardless of other inputs)
822
822
  *
823
823
  * Default if unspecified: '+'
824
- * @default +
825
- * @enum {string}
824
+ * @defaultValue +
825
+
826
826
  */
827
827
  sign?: "+" | "-" | "c";
828
828
  };
829
829
  Error: {
830
- /** @description Error message(s) that occurred while processing the request */
830
+ /** Error message(s) that occurred while processing the request */
831
831
  errorMessage?: string[] | string;
832
832
  };
833
833
  };
834
834
  responses: {
835
- /** @description Request input validation failed */
835
+ /** Request input validation failed */
836
836
  BadRequestError: {
837
837
  headers: {
838
838
  [name: string]: unknown;
@@ -841,7 +841,7 @@ interface components$4 {
841
841
  "application/json": components$4["schemas"]["Error"];
842
842
  };
843
843
  };
844
- /** @description API key or token was not valid */
844
+ /** API key or token was not valid */
845
845
  UnauthorizedError: {
846
846
  headers: {
847
847
  [name: string]: unknown;
@@ -850,7 +850,7 @@ interface components$4 {
850
850
  "application/json": components$4["schemas"]["Error"];
851
851
  };
852
852
  };
853
- /** @description Permission was denied */
853
+ /** Permission was denied */
854
854
  ForbiddenError: {
855
855
  headers: {
856
856
  [name: string]: unknown;
@@ -859,14 +859,14 @@ interface components$4 {
859
859
  "application/json": components$4["schemas"]["Error"];
860
860
  };
861
861
  };
862
- /** @description Too many requests in allowed time period */
862
+ /** Too many requests in allowed time period */
863
863
  RateLimitError: {
864
864
  headers: {
865
865
  [name: string]: unknown;
866
866
  };
867
867
  content?: never;
868
868
  };
869
- /** @description Execution error occurred */
869
+ /** Execution error occurred */
870
870
  InternalServerError: {
871
871
  headers: {
872
872
  [name: string]: unknown;
@@ -891,7 +891,7 @@ interface paths$3 {
891
891
  get: {
892
892
  parameters: {
893
893
  query: {
894
- /** @description The project to fetch dimensions for */
894
+ /** The project to fetch dimensions for */
895
895
  projectId: string;
896
896
  };
897
897
  header?: never;
@@ -900,7 +900,7 @@ interface paths$3 {
900
900
  };
901
901
  requestBody?: never;
902
902
  responses: {
903
- /** @description OK */
903
+ /** OK */
904
904
  200: {
905
905
  headers: {
906
906
  [name: string]: unknown;
@@ -921,7 +921,7 @@ interface paths$3 {
921
921
  put?: never;
922
922
  post?: never;
923
923
  delete?: never;
924
- /** @description Handles preflight requests. This endpoint allows CORS. */
924
+ /** Handles preflight requests. This endpoint allows CORS. */
925
925
  options: {
926
926
  parameters: {
927
927
  query?: never;
@@ -931,7 +931,7 @@ interface paths$3 {
931
931
  };
932
932
  requestBody?: never;
933
933
  responses: {
934
- /** @description OK */
934
+ /** OK */
935
935
  204: {
936
936
  headers: {
937
937
  [name: string]: unknown;
@@ -948,40 +948,40 @@ interface paths$3 {
948
948
  interface components$3 {
949
949
  schemas: {
950
950
  DimensionDefinition: {
951
- /** @description The dimension name (score key) */
951
+ /** The dimension name (score key) */
952
952
  dim: string;
953
953
  /**
954
- * @description The dimension type
954
+ * The dimension type
955
955
  * AGG: Aggregation (intent or audience)
956
956
  * ENR: Enrichment
957
957
  * SIG: Signal
958
- * @enum {string}
958
+
959
959
  */
960
960
  category: "AGG" | "ENR" | "SIG";
961
961
  /**
962
- * @description Subtype of the dimension
962
+ * Subtype of the dimension
963
963
  * AGG:0: Audience
964
964
  * AGG:1: Intent
965
965
  * ENR: Enrichment Category name
966
966
  * SIG: null
967
967
  */
968
968
  subcategory?: string;
969
- /** @description The dimension's name (without category) */
969
+ /** The dimension's name (without category) */
970
970
  name: string;
971
- /** @description Optional description of the dimension */
971
+ /** Optional description of the dimension */
972
972
  description?: string;
973
- /** @description The minimum score possible for the dimension */
973
+ /** The minimum score possible for the dimension */
974
974
  min: number;
975
- /** @description The maximum score possible for the dimension */
975
+ /** The maximum score possible for the dimension */
976
976
  cap: number;
977
977
  };
978
978
  Error: {
979
- /** @description Error message(s) that occurred while processing the request */
979
+ /** Error message(s) that occurred while processing the request */
980
980
  errorMessage?: string[] | string;
981
981
  };
982
982
  };
983
983
  responses: {
984
- /** @description Request input validation failed */
984
+ /** Request input validation failed */
985
985
  BadRequestError: {
986
986
  headers: {
987
987
  [name: string]: unknown;
@@ -990,7 +990,7 @@ interface components$3 {
990
990
  "application/json": components$3["schemas"]["Error"];
991
991
  };
992
992
  };
993
- /** @description API key or token was not valid */
993
+ /** API key or token was not valid */
994
994
  UnauthorizedError: {
995
995
  headers: {
996
996
  [name: string]: unknown;
@@ -999,7 +999,7 @@ interface components$3 {
999
999
  "application/json": components$3["schemas"]["Error"];
1000
1000
  };
1001
1001
  };
1002
- /** @description Permission was denied */
1002
+ /** Permission was denied */
1003
1003
  ForbiddenError: {
1004
1004
  headers: {
1005
1005
  [name: string]: unknown;
@@ -1008,14 +1008,14 @@ interface components$3 {
1008
1008
  "application/json": components$3["schemas"]["Error"];
1009
1009
  };
1010
1010
  };
1011
- /** @description Too many requests in allowed time period */
1011
+ /** Too many requests in allowed time period */
1012
1012
  RateLimitError: {
1013
1013
  headers: {
1014
1014
  [name: string]: unknown;
1015
1015
  };
1016
1016
  content?: never;
1017
1017
  };
1018
- /** @description Execution error occurred */
1018
+ /** Execution error occurred */
1019
1019
  InternalServerError: {
1020
1020
  headers: {
1021
1021
  [name: string]: unknown;
@@ -1037,15 +1037,15 @@ interface paths$2 {
1037
1037
  path?: never;
1038
1038
  cookie?: never;
1039
1039
  };
1040
- /** @description Gets quirk definitions for a project */
1040
+ /** Gets quirk definitions for a project */
1041
1041
  get: {
1042
1042
  parameters: {
1043
1043
  query: {
1044
- /** @description The project to fetch quirk definitions for */
1044
+ /** The project to fetch quirk definitions for */
1045
1045
  projectId: string;
1046
- /** @description Limit the results to a specific quirk ID */
1046
+ /** Limit the results to a specific quirk ID */
1047
1047
  quirkId?: string;
1048
- /** @description Include quirks that are defined by integrations */
1048
+ /** Include quirks that are defined by integrations */
1049
1049
  withIntegrations?: boolean;
1050
1050
  };
1051
1051
  header?: never;
@@ -1054,7 +1054,7 @@ interface paths$2 {
1054
1054
  };
1055
1055
  requestBody?: never;
1056
1056
  responses: {
1057
- /** @description OK */
1057
+ /** OK */
1058
1058
  200: {
1059
1059
  headers: {
1060
1060
  [name: string]: unknown;
@@ -1089,7 +1089,7 @@ interface paths$2 {
1089
1089
  };
1090
1090
  };
1091
1091
  responses: {
1092
- /** @description OK */
1092
+ /** OK */
1093
1093
  204: {
1094
1094
  headers: {
1095
1095
  [name: string]: unknown;
@@ -1121,7 +1121,7 @@ interface paths$2 {
1121
1121
  };
1122
1122
  };
1123
1123
  responses: {
1124
- /** @description OK */
1124
+ /** OK */
1125
1125
  204: {
1126
1126
  headers: {
1127
1127
  [name: string]: unknown;
@@ -1135,7 +1135,7 @@ interface paths$2 {
1135
1135
  500: components$2["responses"]["InternalServerError"];
1136
1136
  };
1137
1137
  };
1138
- /** @description Handles preflight requests. This endpoint allows CORS. */
1138
+ /** Handles preflight requests. This endpoint allows CORS. */
1139
1139
  options: {
1140
1140
  parameters: {
1141
1141
  query?: never;
@@ -1145,7 +1145,7 @@ interface paths$2 {
1145
1145
  };
1146
1146
  requestBody?: never;
1147
1147
  responses: {
1148
- /** @description OK */
1148
+ /** OK */
1149
1149
  204: {
1150
1150
  headers: {
1151
1151
  [name: string]: unknown;
@@ -1172,18 +1172,18 @@ interface components$2 {
1172
1172
  name: string;
1173
1173
  value: string;
1174
1174
  };
1175
- /** @description The source of this quirk. When not defined, it is user specified. */
1175
+ /** The source of this quirk. When not defined, it is user specified. */
1176
1176
  QuirkSource: {
1177
1177
  name: string;
1178
1178
  id: string;
1179
1179
  };
1180
1180
  Error: {
1181
- /** @description Error message(s) that occurred while processing the request */
1181
+ /** Error message(s) that occurred while processing the request */
1182
1182
  errorMessage?: string[] | string;
1183
1183
  };
1184
1184
  };
1185
1185
  responses: {
1186
- /** @description Request input validation failed */
1186
+ /** Request input validation failed */
1187
1187
  BadRequestError: {
1188
1188
  headers: {
1189
1189
  [name: string]: unknown;
@@ -1192,7 +1192,7 @@ interface components$2 {
1192
1192
  "application/json": components$2["schemas"]["Error"];
1193
1193
  };
1194
1194
  };
1195
- /** @description API key or token was not valid */
1195
+ /** API key or token was not valid */
1196
1196
  UnauthorizedError: {
1197
1197
  headers: {
1198
1198
  [name: string]: unknown;
@@ -1201,7 +1201,7 @@ interface components$2 {
1201
1201
  "application/json": components$2["schemas"]["Error"];
1202
1202
  };
1203
1203
  };
1204
- /** @description Permission was denied */
1204
+ /** Permission was denied */
1205
1205
  ForbiddenError: {
1206
1206
  headers: {
1207
1207
  [name: string]: unknown;
@@ -1210,14 +1210,14 @@ interface components$2 {
1210
1210
  "application/json": components$2["schemas"]["Error"];
1211
1211
  };
1212
1212
  };
1213
- /** @description Too many requests in allowed time period */
1213
+ /** Too many requests in allowed time period */
1214
1214
  RateLimitError: {
1215
1215
  headers: {
1216
1216
  [name: string]: unknown;
1217
1217
  };
1218
1218
  content?: never;
1219
1219
  };
1220
- /** @description Execution error occurred */
1220
+ /** Execution error occurred */
1221
1221
  InternalServerError: {
1222
1222
  headers: {
1223
1223
  [name: string]: unknown;
@@ -1242,9 +1242,9 @@ interface paths$1 {
1242
1242
  get: {
1243
1243
  parameters: {
1244
1244
  query: {
1245
- /** @description The project to fetch signals for */
1245
+ /** The project to fetch signals for */
1246
1246
  projectId: string;
1247
- /** @description Limit the results to a specific signal ID */
1247
+ /** Limit the results to a specific signal ID */
1248
1248
  signalId?: string;
1249
1249
  };
1250
1250
  header?: never;
@@ -1253,7 +1253,7 @@ interface paths$1 {
1253
1253
  };
1254
1254
  requestBody?: never;
1255
1255
  responses: {
1256
- /** @description OK */
1256
+ /** OK */
1257
1257
  200: {
1258
1258
  headers: {
1259
1259
  [name: string]: unknown;
@@ -1288,7 +1288,7 @@ interface paths$1 {
1288
1288
  };
1289
1289
  };
1290
1290
  responses: {
1291
- /** @description OK */
1291
+ /** OK */
1292
1292
  204: {
1293
1293
  headers: {
1294
1294
  [name: string]: unknown;
@@ -1320,7 +1320,7 @@ interface paths$1 {
1320
1320
  };
1321
1321
  };
1322
1322
  responses: {
1323
- /** @description OK */
1323
+ /** OK */
1324
1324
  204: {
1325
1325
  headers: {
1326
1326
  [name: string]: unknown;
@@ -1334,7 +1334,7 @@ interface paths$1 {
1334
1334
  500: components$1["responses"]["InternalServerError"];
1335
1335
  };
1336
1336
  };
1337
- /** @description Handles preflight requests. This endpoint allows CORS. */
1337
+ /** Handles preflight requests. This endpoint allows CORS. */
1338
1338
  options: {
1339
1339
  parameters: {
1340
1340
  query?: never;
@@ -1344,7 +1344,7 @@ interface paths$1 {
1344
1344
  };
1345
1345
  requestBody?: never;
1346
1346
  responses: {
1347
- /** @description OK */
1347
+ /** OK */
1348
1348
  204: {
1349
1349
  headers: {
1350
1350
  [name: string]: unknown;
@@ -1365,167 +1365,167 @@ interface components$1 {
1365
1365
  } & components$1["schemas"]["PreviewSignal"];
1366
1366
  SignalCriteriaGroup: {
1367
1367
  /**
1368
- * @description Criteria type (Group of other criteria)
1369
- * @enum {string}
1368
+ * Criteria type (Group of other criteria)
1369
+
1370
1370
  */
1371
1371
  type: "G";
1372
1372
  /**
1373
- * @description The logical operator to apply to the criteria groups
1373
+ * The logical operator to apply to the criteria groups
1374
1374
  * & = AND
1375
1375
  * | = OR
1376
1376
  *
1377
1377
  * Default is `&` if unspecified
1378
- * @enum {string}
1378
+
1379
1379
  */
1380
1380
  op?: "&" | "|";
1381
- /** @description The criteria clauses that make up this grouping of criteria */
1381
+ /** The criteria clauses that make up this grouping of criteria */
1382
1382
  clauses: (components$1["schemas"]["SignalCriteriaGroup"] | components$1["schemas"]["SignalCriteria"])[];
1383
1383
  };
1384
- /** @description Describes a match expression on a string */
1384
+ /** Describes a match expression on a string */
1385
1385
  StringMatch: {
1386
- /** @description The right-hand side of the match expression */
1386
+ /** The right-hand side of the match expression */
1387
1387
  rhs: string;
1388
1388
  /**
1389
- * @description The match operator
1389
+ * The match operator
1390
1390
  * '=' = exact match
1391
1391
  * '~' = contains match
1392
1392
  * '//' = regular expression match
1393
1393
  *
1394
1394
  * Any of the above can be prefixed with '!' to invert the match (i.e. != for 'not an exact match')
1395
- * @enum {string}
1395
+
1396
1396
  */
1397
1397
  op: "=" | "~" | "//" | "!=" | "!~" | "!//";
1398
- /** @description The case sensitivity of the match. Defaults to false if unspecified */
1398
+ /** The case sensitivity of the match. Defaults to false if unspecified */
1399
1399
  cs?: boolean;
1400
1400
  } | {
1401
1401
  /**
1402
- * @description The type of match to perform
1402
+ * The type of match to perform
1403
1403
  * '*' = exists with any value
1404
1404
  * '!*' = does not exist
1405
- * @enum {string}
1405
+
1406
1406
  */
1407
1407
  op: "*" | "!*";
1408
1408
  };
1409
- /** @description Matches a web cookie value */
1409
+ /** Matches a web cookie value */
1410
1410
  CookieCriteria: {
1411
1411
  /** @enum {string} */
1412
1412
  type: "CK";
1413
- /** @description The name of the cookie to match */
1413
+ /** The name of the cookie to match */
1414
1414
  cookieName: string;
1415
- /** @description The value to match the cookie against */
1415
+ /** The value to match the cookie against */
1416
1416
  match: components$1["schemas"]["StringMatch"];
1417
1417
  };
1418
- /** @description Matches a URL query string parameter value */
1418
+ /** Matches a URL query string parameter value */
1419
1419
  QueryStringCriteria: {
1420
1420
  /** @enum {string} */
1421
1421
  type: "QS";
1422
- /** @description The name of the query string parameter to match */
1422
+ /** The name of the query string parameter to match */
1423
1423
  queryName: string;
1424
- /** @description The value to match the query string parameter against */
1424
+ /** The value to match the query string parameter against */
1425
1425
  match: components$1["schemas"]["StringMatch"];
1426
1426
  };
1427
- /** @description Matches a visitor quirk key and value */
1427
+ /** Matches a visitor quirk key and value */
1428
1428
  QuirkCriteria: {
1429
1429
  /** @enum {string} */
1430
1430
  type: "QK";
1431
- /** @description The name of the quirk key to match */
1431
+ /** The name of the quirk key to match */
1432
1432
  key: string;
1433
- /** @description The quirk value to match against */
1433
+ /** The quirk value to match against */
1434
1434
  match: components$1["schemas"]["StringMatch"];
1435
1435
  };
1436
- /** @description Matches an analytics event name being fired */
1436
+ /** Matches an analytics event name being fired */
1437
1437
  EventCriteria: {
1438
1438
  /** @enum {string} */
1439
1439
  type: "EVT";
1440
- /** @description How to match the event name */
1440
+ /** How to match the event name */
1441
1441
  event: components$1["schemas"]["StringMatch"];
1442
1442
  };
1443
1443
  /**
1444
- * @description Matches the current page's absolute path (i.e. /path/to/page.html)
1444
+ * Matches the current page's absolute path (i.e. /path/to/page.html)
1445
1445
  * Does not include the query string or protocol and hostname (i.e. NOT https://foo.com/path/to/page.html?query=something)
1446
1446
  */
1447
1447
  CurrentPageCriteria: {
1448
1448
  /** @enum {string} */
1449
1449
  type: "PV";
1450
- /** @description The page/route path to match as a page that has been visited */
1450
+ /** The page/route path to match as a page that has been visited */
1451
1451
  path: components$1["schemas"]["StringMatch"];
1452
1452
  };
1453
- /** @description Describes a match expression on a number */
1453
+ /** Describes a match expression on a number */
1454
1454
  NumberMatch: {
1455
- /** @description The right-hand side of the match expression */
1455
+ /** The right-hand side of the match expression */
1456
1456
  rhs: number;
1457
1457
  /**
1458
- * @description The type of match to perform
1458
+ * The type of match to perform
1459
1459
  * '=' = exact match
1460
1460
  * '!=' = not an exact match
1461
1461
  * '<' = less than match expression
1462
1462
  * '>' = greater than match expression
1463
- * @enum {string}
1463
+
1464
1464
  */
1465
1465
  op: "=" | "<" | ">" | "!=";
1466
1466
  };
1467
1467
  PageViewCountCriteria: {
1468
1468
  /** @enum {string} */
1469
1469
  type: "PVC";
1470
- /** @description The expression to match the page view count against */
1470
+ /** The expression to match the page view count against */
1471
1471
  match: components$1["schemas"]["NumberMatch"];
1472
1472
  };
1473
1473
  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"];
1474
1474
  RootSignalCriteriaGroup: {
1475
1475
  /**
1476
- * @description Criteria type (Group of other criteria)
1477
- * @enum {string}
1476
+ * Criteria type (Group of other criteria)
1477
+
1478
1478
  */
1479
1479
  type: "G";
1480
1480
  /**
1481
- * @description The logical operator to apply to the criteria groups
1481
+ * The logical operator to apply to the criteria groups
1482
1482
  * & = AND
1483
1483
  * | = OR
1484
1484
  *
1485
1485
  * Default is `&` if unspecified
1486
- * @default &
1487
- * @enum {string}
1486
+ * @defaultValue &
1487
+
1488
1488
  */
1489
1489
  op?: "&" | "|";
1490
- /** @description The criteria clauses that make up this grouping of criteria */
1490
+ /** The criteria clauses that make up this grouping of criteria */
1491
1491
  clauses: (components$1["schemas"]["SignalCriteriaGroup"] | components$1["schemas"]["SignalCriteria"])[];
1492
1492
  };
1493
1493
  Conversion: {
1494
1494
  /**
1495
- * @description The frequency of the conversion event
1496
- * @enum {string}
1495
+ * The frequency of the conversion event
1496
+
1497
1497
  */
1498
1498
  freq: "O";
1499
1499
  };
1500
1500
  Signal: {
1501
- /** @description The signal strength per activation (each time its criteria are true, this score is added) */
1501
+ /** The signal strength per activation (each time its criteria are true, this score is added) */
1502
1502
  str: number;
1503
- /** @description The maximum visitor score allowed for this signal */
1503
+ /** The maximum visitor score allowed for this signal */
1504
1504
  cap: number;
1505
1505
  /**
1506
- * @description How long the signal's score should persist
1506
+ * How long the signal's score should persist
1507
1507
  * 's' = current session (expires after a period of inactivity)
1508
1508
  * 'p' = permanent (expires as far in the future as possible, may be limited by browser security settings)
1509
1509
  * 't' = transient (score tracks the current state of the criteria every time scores are updated)
1510
- * @enum {string}
1510
+
1511
1511
  */
1512
1512
  dur: "s" | "p" | "t";
1513
1513
  crit: components$1["schemas"]["RootSignalCriteriaGroup"];
1514
1514
  conversion?: components$1["schemas"]["Conversion"] | null;
1515
1515
  };
1516
1516
  PreviewSignal: components$1["schemas"]["Signal"] & {
1517
- /** @description Friendly name of the signal */
1517
+ /** Friendly name of the signal */
1518
1518
  name: string;
1519
- /** @description Description of the signal */
1519
+ /** Description of the signal */
1520
1520
  description?: string;
1521
1521
  };
1522
1522
  Error: {
1523
- /** @description Error message(s) that occurred while processing the request */
1523
+ /** Error message(s) that occurred while processing the request */
1524
1524
  errorMessage?: string[] | string;
1525
1525
  };
1526
1526
  };
1527
1527
  responses: {
1528
- /** @description Request input validation failed */
1528
+ /** Request input validation failed */
1529
1529
  BadRequestError: {
1530
1530
  headers: {
1531
1531
  [name: string]: unknown;
@@ -1534,7 +1534,7 @@ interface components$1 {
1534
1534
  "application/json": components$1["schemas"]["Error"];
1535
1535
  };
1536
1536
  };
1537
- /** @description API key or token was not valid */
1537
+ /** API key or token was not valid */
1538
1538
  UnauthorizedError: {
1539
1539
  headers: {
1540
1540
  [name: string]: unknown;
@@ -1543,7 +1543,7 @@ interface components$1 {
1543
1543
  "application/json": components$1["schemas"]["Error"];
1544
1544
  };
1545
1545
  };
1546
- /** @description Permission was denied */
1546
+ /** Permission was denied */
1547
1547
  ForbiddenError: {
1548
1548
  headers: {
1549
1549
  [name: string]: unknown;
@@ -1552,14 +1552,14 @@ interface components$1 {
1552
1552
  "application/json": components$1["schemas"]["Error"];
1553
1553
  };
1554
1554
  };
1555
- /** @description Too many requests in allowed time period */
1555
+ /** Too many requests in allowed time period */
1556
1556
  RateLimitError: {
1557
1557
  headers: {
1558
1558
  [name: string]: unknown;
1559
1559
  };
1560
1560
  content?: never;
1561
1561
  };
1562
- /** @description Execution error occurred */
1562
+ /** Execution error occurred */
1563
1563
  InternalServerError: {
1564
1564
  headers: {
1565
1565
  [name: string]: unknown;
@@ -1581,13 +1581,13 @@ interface paths {
1581
1581
  path?: never;
1582
1582
  cookie?: never;
1583
1583
  };
1584
- /** @description Gets A/B test definitions for a project */
1584
+ /** Gets A/B test definitions for a project */
1585
1585
  get: {
1586
1586
  parameters: {
1587
1587
  query: {
1588
- /** @description The project to fetch tests for */
1588
+ /** The project to fetch tests for */
1589
1589
  projectId: string;
1590
- /** @description Limit the results to a specific test public ID */
1590
+ /** Limit the results to a specific test public ID */
1591
1591
  testId?: string;
1592
1592
  };
1593
1593
  header?: never;
@@ -1596,7 +1596,7 @@ interface paths {
1596
1596
  };
1597
1597
  requestBody?: never;
1598
1598
  responses: {
1599
- /** @description OK */
1599
+ /** OK */
1600
1600
  200: {
1601
1601
  headers: {
1602
1602
  [name: string]: unknown;
@@ -1631,7 +1631,7 @@ interface paths {
1631
1631
  };
1632
1632
  };
1633
1633
  responses: {
1634
- /** @description OK */
1634
+ /** OK */
1635
1635
  204: {
1636
1636
  headers: {
1637
1637
  [name: string]: unknown;
@@ -1663,7 +1663,7 @@ interface paths {
1663
1663
  };
1664
1664
  };
1665
1665
  responses: {
1666
- /** @description OK */
1666
+ /** OK */
1667
1667
  204: {
1668
1668
  headers: {
1669
1669
  [name: string]: unknown;
@@ -1677,7 +1677,7 @@ interface paths {
1677
1677
  500: components["responses"]["InternalServerError"];
1678
1678
  };
1679
1679
  };
1680
- /** @description Handles preflight requests. This endpoint allows CORS. */
1680
+ /** Handles preflight requests. This endpoint allows CORS. */
1681
1681
  options: {
1682
1682
  parameters: {
1683
1683
  query?: never;
@@ -1687,7 +1687,7 @@ interface paths {
1687
1687
  };
1688
1688
  requestBody?: never;
1689
1689
  responses: {
1690
- /** @description OK */
1690
+ /** OK */
1691
1691
  204: {
1692
1692
  headers: {
1693
1693
  [name: string]: unknown;
@@ -1708,16 +1708,16 @@ interface components {
1708
1708
  name: string;
1709
1709
  winning_variant_id?: string;
1710
1710
  default_variant_id?: string;
1711
- /** @default false */
1711
+ /** @defaultValue false */
1712
1712
  closed?: boolean;
1713
1713
  };
1714
1714
  Error: {
1715
- /** @description Error message(s) that occurred while processing the request */
1715
+ /** Error message(s) that occurred while processing the request */
1716
1716
  errorMessage?: string[] | string;
1717
1717
  };
1718
1718
  };
1719
1719
  responses: {
1720
- /** @description Request input validation failed */
1720
+ /** Request input validation failed */
1721
1721
  BadRequestError: {
1722
1722
  headers: {
1723
1723
  [name: string]: unknown;
@@ -1726,7 +1726,7 @@ interface components {
1726
1726
  "application/json": components["schemas"]["Error"];
1727
1727
  };
1728
1728
  };
1729
- /** @description API key or token was not valid */
1729
+ /** API key or token was not valid */
1730
1730
  UnauthorizedError: {
1731
1731
  headers: {
1732
1732
  [name: string]: unknown;
@@ -1735,7 +1735,7 @@ interface components {
1735
1735
  "application/json": components["schemas"]["Error"];
1736
1736
  };
1737
1737
  };
1738
- /** @description Permission was denied */
1738
+ /** Permission was denied */
1739
1739
  ForbiddenError: {
1740
1740
  headers: {
1741
1741
  [name: string]: unknown;
@@ -1744,14 +1744,14 @@ interface components {
1744
1744
  "application/json": components["schemas"]["Error"];
1745
1745
  };
1746
1746
  };
1747
- /** @description Too many requests in allowed time period */
1747
+ /** Too many requests in allowed time period */
1748
1748
  RateLimitError: {
1749
1749
  headers: {
1750
1750
  [name: string]: unknown;
1751
1751
  };
1752
1752
  content?: never;
1753
1753
  };
1754
- /** @description Execution error occurred */
1754
+ /** Execution error occurred */
1755
1755
  InternalServerError: {
1756
1756
  headers: {
1757
1757
  [name: string]: unknown;