@connectreport/connectreport-js 2.80.2 → 2.81.0-beta.1

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.
Files changed (63) hide show
  1. package/.openapi-generator/FILES +0 -1
  2. package/README.md +1 -1
  3. package/api.ts +220 -22
  4. package/base.ts +2 -2
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/index.cjs +12 -5
  8. package/dist/index.cjs.map +1 -1
  9. package/dist/index.d.cts +220 -24
  10. package/dist/index.d.ts +220 -24
  11. package/dist/index.js +11 -5
  12. package/dist/index.js.map +1 -1
  13. package/docs/assets/css/main.css +2679 -0
  14. package/docs/assets/images/icons.png +0 -0
  15. package/docs/assets/images/icons@2x.png +0 -0
  16. package/docs/assets/images/widgets.png +0 -0
  17. package/docs/assets/images/widgets@2x.png +0 -0
  18. package/docs/assets/js/main.js +1 -0
  19. package/docs/assets/js/search.json +1 -0
  20. package/docs/classes/_api_.basetemplatesapi.html +351 -0
  21. package/docs/classes/_api_.documentsapi.html +314 -0
  22. package/docs/classes/_api_.filtercyclesapi.html +483 -0
  23. package/docs/classes/_api_.imagesapi.html +354 -0
  24. package/docs/classes/_api_.jobsapi.html +311 -0
  25. package/docs/classes/_api_.reportsapi.html +400 -0
  26. package/docs/classes/_api_.reporttasksapi.html +503 -0
  27. package/docs/classes/_api_.templatesapi.html +676 -0
  28. package/docs/classes/_base_.baseapi.html +283 -0
  29. package/docs/classes/_base_.requirederror.html +291 -0
  30. package/docs/classes/_configuration_.configuration.html +345 -0
  31. package/docs/classes/_index_.connectreport.html +317 -0
  32. package/docs/enums/_api_.filtercycleemailenum.html +196 -0
  33. package/docs/enums/_api_.filtercyclefrequencyenum.html +238 -0
  34. package/docs/enums/_api_.reporttaskemailenum.html +196 -0
  35. package/docs/enums/_api_.reporttaskfrequencyenum.html +238 -0
  36. package/docs/enums/_api_.templateplatformenum.html +182 -0
  37. package/docs/globals.html +132 -0
  38. package/docs/index.html +145 -0
  39. package/docs/interfaces/_api_.filtercycle.html +791 -0
  40. package/docs/interfaces/_api_.filtercycleallof.html +273 -0
  41. package/docs/interfaces/_api_.filtercyclealloffieldinfo.html +228 -0
  42. package/docs/interfaces/_api_.filtercyclealloffieldvalues.html +228 -0
  43. package/docs/interfaces/_api_.inlineresponse200.html +186 -0
  44. package/docs/interfaces/_api_.inlineresponse2001.html +207 -0
  45. package/docs/interfaces/_api_.job.html +270 -0
  46. package/docs/interfaces/_api_.modelerror.html +207 -0
  47. package/docs/interfaces/_api_.report.html +348 -0
  48. package/docs/interfaces/_api_.reporttask.html +683 -0
  49. package/docs/interfaces/_api_.reporttaskcustomselection.html +234 -0
  50. package/docs/interfaces/_api_.reporttaskfieldvalues.html +207 -0
  51. package/docs/interfaces/_api_.reporttaskfiltersets.html +207 -0
  52. package/docs/interfaces/_api_.reporttaskgroupstosharewith.html +186 -0
  53. package/docs/interfaces/_api_.reporttasktags.html +207 -0
  54. package/docs/interfaces/_api_.reporttaskuserstosharewith.html +186 -0
  55. package/docs/interfaces/_api_.reporttaskvariables.html +207 -0
  56. package/docs/interfaces/_api_.template.html +291 -0
  57. package/docs/interfaces/_base_.requestargs.html +205 -0
  58. package/docs/interfaces/_configuration_.configurationparameters.html +253 -0
  59. package/docs/modules/_api_.html +4377 -0
  60. package/docs/modules/_base_.html +238 -0
  61. package/docs/modules/_configuration_.html +144 -0
  62. package/docs/modules/_index_.html +135 -0
  63. package/package.json +1 -1
@@ -0,0 +1,683 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>ReportTask | @connectreport/connectreport-js</title>
7
+ <meta name="description" content="Documentation for @connectreport/connectreport-js">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ </head>
11
+ <body>
12
+ <header>
13
+ <div class="tsd-page-toolbar">
14
+ <div class="container">
15
+ <div class="table-wrap">
16
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
17
+ <div class="field">
18
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19
+ <input id="tsd-search-field" type="text" />
20
+ </div>
21
+ <ul class="results">
22
+ <li class="state loading">Preparing search index...</li>
23
+ <li class="state failure">The search index is not available</li>
24
+ </ul>
25
+ <a href="../index.html" class="title">@connectreport/connectreport-js</a>
26
+ </div>
27
+ <div class="table-cell" id="tsd-widgets">
28
+ <div id="tsd-filter">
29
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30
+ <div class="tsd-filter-group">
31
+ <div class="tsd-select" id="tsd-filter-visibility">
32
+ <span class="tsd-select-label">All</span>
33
+ <ul class="tsd-select-list">
34
+ <li data-value="public">Public</li>
35
+ <li data-value="protected">Public/Protected</li>
36
+ <li data-value="private" class="selected">All</li>
37
+ </ul>
38
+ </div>
39
+ <input type="checkbox" id="tsd-filter-inherited" checked />
40
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41
+ <input type="checkbox" id="tsd-filter-externals" checked />
42
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43
+ <input type="checkbox" id="tsd-filter-only-exported" />
44
+ <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45
+ </div>
46
+ </div>
47
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ </div>
52
+ <div class="tsd-page-title">
53
+ <div class="container">
54
+ <ul class="tsd-breadcrumb">
55
+ <li>
56
+ <a href="../globals.html">Globals</a>
57
+ </li>
58
+ <li>
59
+ <a href="../modules/_api_.html">&quot;api&quot;</a>
60
+ </li>
61
+ <li>
62
+ <a href="_api_.reporttask.html">ReportTask</a>
63
+ </li>
64
+ </ul>
65
+ <h1>Interface ReportTask</h1>
66
+ </div>
67
+ </div>
68
+ </header>
69
+ <div class="container container-main">
70
+ <div class="row">
71
+ <div class="col-8 col-content">
72
+ <section class="tsd-panel tsd-comment">
73
+ <div class="tsd-comment tsd-typography">
74
+ <dl class="tsd-comment-tags">
75
+ <dt>export</dt>
76
+ <dd></dd>
77
+ <dt>interface</dt>
78
+ <dd><p>ReportTask</p>
79
+ </dd>
80
+ </dl>
81
+ </div>
82
+ </section>
83
+ <section class="tsd-panel tsd-hierarchy">
84
+ <h3>Hierarchy</h3>
85
+ <ul class="tsd-hierarchy">
86
+ <li>
87
+ <span class="target">ReportTask</span>
88
+ </li>
89
+ </ul>
90
+ </section>
91
+ <section class="tsd-panel-group tsd-index-group">
92
+ <h2>Index</h2>
93
+ <section class="tsd-panel tsd-index-panel">
94
+ <div class="tsd-index-content">
95
+ <section class="tsd-index-section tsd-is-external">
96
+ <h3>Properties</h3>
97
+ <ul class="tsd-index-list">
98
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#at" class="tsd-kind-icon">at</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#averagetimetogenerate" class="tsd-kind-icon">average<wbr>Time<wbr>ToGenerate</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#customselection" class="tsd-kind-icon">custom<wbr>Selection</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#dataplatformwaittime" class="tsd-kind-icon">data<wbr>Platform<wbr>Wait<wbr>Time</a></li>
102
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#email" class="tsd-kind-icon">email</a></li>
103
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#enabled" class="tsd-kind-icon">enabled</a></li>
104
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#endon" class="tsd-kind-icon">end<wbr>On</a></li>
105
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#error" class="tsd-kind-icon">error</a></li>
106
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#every" class="tsd-kind-icon">every</a></li>
107
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#filtercycleid" class="tsd-kind-icon">filter<wbr>Cycle<wbr>Id</a></li>
108
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#filtersets" class="tsd-kind-icon">filter<wbr>Sets</a></li>
109
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#frequency" class="tsd-kind-icon">frequency</a></li>
110
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#groupstosharewith" class="tsd-kind-icon">groups<wbr>ToShare<wbr>With</a></li>
111
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#id" class="tsd-kind-icon">id</a></li>
112
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#meta" class="tsd-kind-icon">meta</a></li>
113
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#nextrunat" class="tsd-kind-icon">next<wbr>Run<wbr>At</a></li>
114
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#starton" class="tsd-kind-icon">start<wbr>On</a></li>
115
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#tags" class="tsd-kind-icon">tags</a></li>
116
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#templateid" class="tsd-kind-icon">template<wbr>Id</a></li>
117
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#title" class="tsd-kind-icon">title</a></li>
118
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#userstosharewith" class="tsd-kind-icon">users<wbr>ToShare<wbr>With</a></li>
119
+ <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_api_.reporttask.html#variables" class="tsd-kind-icon">variables</a></li>
120
+ </ul>
121
+ </section>
122
+ </div>
123
+ </section>
124
+ </section>
125
+ <section class="tsd-panel-group tsd-member-group tsd-is-external">
126
+ <h2>Properties</h2>
127
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
128
+ <a name="at" class="tsd-anchor"></a>
129
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> at</h3>
130
+ <div class="tsd-signature tsd-kind-icon">at<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
+ <aside class="tsd-sources">
132
+ <ul>
133
+ <li>Defined in api.ts:506</li>
134
+ </ul>
135
+ </aside>
136
+ <div class="tsd-comment tsd-typography">
137
+ <div class="lead">
138
+ <p>Datetime in UTC when the report task will execute</p>
139
+ </div>
140
+ <dl class="tsd-comment-tags">
141
+ <dt>memberof</dt>
142
+ <dd><p>ReportTask</p>
143
+ </dd>
144
+ </dl>
145
+ </div>
146
+ </section>
147
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
148
+ <a name="averagetimetogenerate" class="tsd-anchor"></a>
149
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> average<wbr>Time<wbr>ToGenerate</h3>
150
+ <div class="tsd-signature tsd-kind-icon">average<wbr>Time<wbr>ToGenerate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
151
+ <aside class="tsd-sources">
152
+ <ul>
153
+ <li>Defined in api.ts:542</li>
154
+ </ul>
155
+ </aside>
156
+ <div class="tsd-comment tsd-typography">
157
+ <div class="lead">
158
+ <p>The average time to run the report task, in minutes</p>
159
+ </div>
160
+ <dl class="tsd-comment-tags">
161
+ <dt>memberof</dt>
162
+ <dd><p>ReportTask</p>
163
+ </dd>
164
+ </dl>
165
+ </div>
166
+ </section>
167
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
168
+ <a name="customselection" class="tsd-anchor"></a>
169
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> custom<wbr>Selection</h3>
170
+ <div class="tsd-signature tsd-kind-icon">custom<wbr>Selection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="_api_.reporttaskcustomselection.html" class="tsd-signature-type">ReportTaskCustomSelection</a><span class="tsd-signature-symbol">&gt;</span></div>
171
+ <aside class="tsd-sources">
172
+ <ul>
173
+ <li>Defined in api.ts:548</li>
174
+ </ul>
175
+ </aside>
176
+ <div class="tsd-comment tsd-typography">
177
+ <div class="lead">
178
+ <p>Custom filters to apply. This field will be updated entirely if provided</p>
179
+ </div>
180
+ <dl class="tsd-comment-tags">
181
+ <dt>memberof</dt>
182
+ <dd><p>ReportTask</p>
183
+ </dd>
184
+ </dl>
185
+ </div>
186
+ </section>
187
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
188
+ <a name="dataplatformwaittime" class="tsd-anchor"></a>
189
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> data<wbr>Platform<wbr>Wait<wbr>Time</h3>
190
+ <div class="tsd-signature tsd-kind-icon">data<wbr>Platform<wbr>Wait<wbr>Time<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
191
+ <aside class="tsd-sources">
192
+ <ul>
193
+ <li>Defined in api.ts:566</li>
194
+ </ul>
195
+ </aside>
196
+ <div class="tsd-comment tsd-typography">
197
+ <div class="lead">
198
+ <p>The time spent waiting on data platform responses during the last report task execution, in minutes</p>
199
+ </div>
200
+ <dl class="tsd-comment-tags">
201
+ <dt>memberof</dt>
202
+ <dd><p>ReportTask</p>
203
+ </dd>
204
+ </dl>
205
+ </div>
206
+ </section>
207
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
208
+ <a name="email" class="tsd-anchor"></a>
209
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> email</h3>
210
+ <div class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">:</span> <a href="../enums/_api_.reporttaskemailenum.html" class="tsd-signature-type">ReportTaskEmailEnum</a></div>
211
+ <aside class="tsd-sources">
212
+ <ul>
213
+ <li>Defined in api.ts:572</li>
214
+ </ul>
215
+ </aside>
216
+ <div class="tsd-comment tsd-typography">
217
+ <div class="lead">
218
+ <p>Denotes whether the generated report should be emailed to its users or groups after a successful run</p>
219
+ </div>
220
+ <dl class="tsd-comment-tags">
221
+ <dt>memberof</dt>
222
+ <dd><p>ReportTask</p>
223
+ </dd>
224
+ </dl>
225
+ </div>
226
+ </section>
227
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
228
+ <a name="enabled" class="tsd-anchor"></a>
229
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
230
+ <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
231
+ <aside class="tsd-sources">
232
+ <ul>
233
+ <li>Defined in api.ts:512</li>
234
+ </ul>
235
+ </aside>
236
+ <div class="tsd-comment tsd-typography">
237
+ <div class="lead">
238
+ <p>Denotes whether the report task will go into the report processing queue</p>
239
+ </div>
240
+ <dl class="tsd-comment-tags">
241
+ <dt>memberof</dt>
242
+ <dd><p>ReportTask</p>
243
+ </dd>
244
+ </dl>
245
+ </div>
246
+ </section>
247
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
248
+ <a name="endon" class="tsd-anchor"></a>
249
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> end<wbr>On</h3>
250
+ <div class="tsd-signature tsd-kind-icon">end<wbr>On<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
251
+ <aside class="tsd-sources">
252
+ <ul>
253
+ <li>Defined in api.ts:488</li>
254
+ </ul>
255
+ </aside>
256
+ <div class="tsd-comment tsd-typography">
257
+ <div class="lead">
258
+ <p>Datetime in UTC when report task schedule will end</p>
259
+ </div>
260
+ <dl class="tsd-comment-tags">
261
+ <dt>memberof</dt>
262
+ <dd><p>ReportTask</p>
263
+ </dd>
264
+ </dl>
265
+ </div>
266
+ </section>
267
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
268
+ <a name="error" class="tsd-anchor"></a>
269
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3>
270
+ <div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
271
+ <aside class="tsd-sources">
272
+ <ul>
273
+ <li>Defined in api.ts:536</li>
274
+ </ul>
275
+ </aside>
276
+ <div class="tsd-comment tsd-typography">
277
+ <div class="lead">
278
+ <p>The error object from the last report task execution, if applicable</p>
279
+ </div>
280
+ <dl class="tsd-comment-tags">
281
+ <dt>memberof</dt>
282
+ <dd><p>ReportTask</p>
283
+ </dd>
284
+ </dl>
285
+ </div>
286
+ </section>
287
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
288
+ <a name="every" class="tsd-anchor"></a>
289
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> every</h3>
290
+ <div class="tsd-signature tsd-kind-icon">every<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
291
+ <aside class="tsd-sources">
292
+ <ul>
293
+ <li>Defined in api.ts:500</li>
294
+ </ul>
295
+ </aside>
296
+ <div class="tsd-comment tsd-typography">
297
+ <div class="lead">
298
+ <p>The interval of the report task&#39;s schedule</p>
299
+ </div>
300
+ <dl class="tsd-comment-tags">
301
+ <dt>memberof</dt>
302
+ <dd><p>ReportTask</p>
303
+ </dd>
304
+ </dl>
305
+ </div>
306
+ </section>
307
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
308
+ <a name="filtercycleid" class="tsd-anchor"></a>
309
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr>Cycle<wbr>Id</h3>
310
+ <div class="tsd-signature tsd-kind-icon">filter<wbr>Cycle<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
311
+ <aside class="tsd-sources">
312
+ <ul>
313
+ <li>Defined in api.ts:524</li>
314
+ </ul>
315
+ </aside>
316
+ <div class="tsd-comment tsd-typography">
317
+ <dl class="tsd-comment-tags">
318
+ <dt>memberof</dt>
319
+ <dd><p>ReportTask</p>
320
+ </dd>
321
+ </dl>
322
+ </div>
323
+ </section>
324
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
325
+ <a name="filtersets" class="tsd-anchor"></a>
326
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> filter<wbr>Sets</h3>
327
+ <div class="tsd-signature tsd-kind-icon">filter<wbr>Sets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="_api_.reporttaskfiltersets.html" class="tsd-signature-type">ReportTaskFilterSets</a><span class="tsd-signature-symbol">&gt;</span></div>
328
+ <aside class="tsd-sources">
329
+ <ul>
330
+ <li>Defined in api.ts:518</li>
331
+ </ul>
332
+ </aside>
333
+ <div class="tsd-comment tsd-typography">
334
+ <div class="lead">
335
+ <p>Array of objects denoting filter sets to apply to the report task</p>
336
+ </div>
337
+ <dl class="tsd-comment-tags">
338
+ <dt>memberof</dt>
339
+ <dd><p>ReportTask</p>
340
+ </dd>
341
+ </dl>
342
+ </div>
343
+ </section>
344
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
345
+ <a name="frequency" class="tsd-anchor"></a>
346
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> frequency</h3>
347
+ <div class="tsd-signature tsd-kind-icon">frequency<span class="tsd-signature-symbol">:</span> <a href="../enums/_api_.reporttaskfrequencyenum.html" class="tsd-signature-type">ReportTaskFrequencyEnum</a></div>
348
+ <aside class="tsd-sources">
349
+ <ul>
350
+ <li>Defined in api.ts:494</li>
351
+ </ul>
352
+ </aside>
353
+ <div class="tsd-comment tsd-typography">
354
+ <div class="lead">
355
+ <p>Describes the frequency of the report task&#39;s schedule</p>
356
+ </div>
357
+ <dl class="tsd-comment-tags">
358
+ <dt>memberof</dt>
359
+ <dd><p>ReportTask</p>
360
+ </dd>
361
+ </dl>
362
+ </div>
363
+ </section>
364
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
365
+ <a name="groupstosharewith" class="tsd-anchor"></a>
366
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> groups<wbr>ToShare<wbr>With</h3>
367
+ <div class="tsd-signature tsd-kind-icon">groups<wbr>ToShare<wbr>With<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="_api_.reporttaskgroupstosharewith.html" class="tsd-signature-type">ReportTaskGroupsToShareWith</a><span class="tsd-signature-symbol">&gt;</span></div>
368
+ <aside class="tsd-sources">
369
+ <ul>
370
+ <li>Defined in api.ts:584</li>
371
+ </ul>
372
+ </aside>
373
+ <div class="tsd-comment tsd-typography">
374
+ <div class="lead">
375
+ <p>Users to share the published report with. This field will be updated entirely if provided</p>
376
+ </div>
377
+ <dl class="tsd-comment-tags">
378
+ <dt>memberof</dt>
379
+ <dd><p>ReportTask</p>
380
+ </dd>
381
+ </dl>
382
+ </div>
383
+ </section>
384
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
385
+ <a name="id" class="tsd-anchor"></a>
386
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
387
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
388
+ <aside class="tsd-sources">
389
+ <ul>
390
+ <li>Defined in api.ts:464</li>
391
+ </ul>
392
+ </aside>
393
+ <div class="tsd-comment tsd-typography">
394
+ <dl class="tsd-comment-tags">
395
+ <dt>memberof</dt>
396
+ <dd><p>ReportTask</p>
397
+ </dd>
398
+ </dl>
399
+ </div>
400
+ </section>
401
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
402
+ <a name="meta" class="tsd-anchor"></a>
403
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> meta</h3>
404
+ <div class="tsd-signature tsd-kind-icon">meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
405
+ <aside class="tsd-sources">
406
+ <ul>
407
+ <li>Defined in api.ts:560</li>
408
+ </ul>
409
+ </aside>
410
+ <div class="tsd-comment tsd-typography">
411
+ <dl class="tsd-comment-tags">
412
+ <dt>memberof</dt>
413
+ <dd><p>ReportTask</p>
414
+ </dd>
415
+ </dl>
416
+ </div>
417
+ <div class="tsd-type-declaration">
418
+ <h4>Type declaration</h4>
419
+ <ul class="tsd-parameters">
420
+ <li class="tsd-parameter-index-signature">
421
+ <h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">string</span></h5>
422
+ </li>
423
+ </ul>
424
+ </div>
425
+ </section>
426
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
427
+ <a name="nextrunat" class="tsd-anchor"></a>
428
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Run<wbr>At</h3>
429
+ <div class="tsd-signature tsd-kind-icon">next<wbr>Run<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
430
+ <aside class="tsd-sources">
431
+ <ul>
432
+ <li>Defined in api.ts:530</li>
433
+ </ul>
434
+ </aside>
435
+ <div class="tsd-comment tsd-typography">
436
+ <div class="lead">
437
+ <p>Calculated datetime in UTC when the report task will run next, if applicable</p>
438
+ </div>
439
+ <dl class="tsd-comment-tags">
440
+ <dt>memberof</dt>
441
+ <dd><p>ReportTask</p>
442
+ </dd>
443
+ </dl>
444
+ </div>
445
+ </section>
446
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
447
+ <a name="starton" class="tsd-anchor"></a>
448
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> start<wbr>On</h3>
449
+ <div class="tsd-signature tsd-kind-icon">start<wbr>On<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
450
+ <aside class="tsd-sources">
451
+ <ul>
452
+ <li>Defined in api.ts:482</li>
453
+ </ul>
454
+ </aside>
455
+ <div class="tsd-comment tsd-typography">
456
+ <div class="lead">
457
+ <p>Datetime in UTC when report task&#39;s schedule will start</p>
458
+ </div>
459
+ <dl class="tsd-comment-tags">
460
+ <dt>memberof</dt>
461
+ <dd><p>ReportTask</p>
462
+ </dd>
463
+ </dl>
464
+ </div>
465
+ </section>
466
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
467
+ <a name="tags" class="tsd-anchor"></a>
468
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tags</h3>
469
+ <div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="_api_.reporttasktags.html" class="tsd-signature-type">ReportTaskTags</a><span class="tsd-signature-symbol">&gt;</span></div>
470
+ <aside class="tsd-sources">
471
+ <ul>
472
+ <li>Defined in api.ts:590</li>
473
+ </ul>
474
+ </aside>
475
+ <div class="tsd-comment tsd-typography">
476
+ <dl class="tsd-comment-tags">
477
+ <dt>memberof</dt>
478
+ <dd><p>ReportTask</p>
479
+ </dd>
480
+ </dl>
481
+ </div>
482
+ </section>
483
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
484
+ <a name="templateid" class="tsd-anchor"></a>
485
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> template<wbr>Id</h3>
486
+ <div class="tsd-signature tsd-kind-icon">template<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
487
+ <aside class="tsd-sources">
488
+ <ul>
489
+ <li>Defined in api.ts:476</li>
490
+ </ul>
491
+ </aside>
492
+ <div class="tsd-comment tsd-typography">
493
+ <dl class="tsd-comment-tags">
494
+ <dt>memberof</dt>
495
+ <dd><p>ReportTask</p>
496
+ </dd>
497
+ </dl>
498
+ </div>
499
+ </section>
500
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
501
+ <a name="title" class="tsd-anchor"></a>
502
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
503
+ <div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
504
+ <aside class="tsd-sources">
505
+ <ul>
506
+ <li>Defined in api.ts:470</li>
507
+ </ul>
508
+ </aside>
509
+ <div class="tsd-comment tsd-typography">
510
+ <div class="lead">
511
+ <p>Title of the report task</p>
512
+ </div>
513
+ <dl class="tsd-comment-tags">
514
+ <dt>memberof</dt>
515
+ <dd><p>ReportTask</p>
516
+ </dd>
517
+ </dl>
518
+ </div>
519
+ </section>
520
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
521
+ <a name="userstosharewith" class="tsd-anchor"></a>
522
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> users<wbr>ToShare<wbr>With</h3>
523
+ <div class="tsd-signature tsd-kind-icon">users<wbr>ToShare<wbr>With<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="_api_.reporttaskuserstosharewith.html" class="tsd-signature-type">ReportTaskUsersToShareWith</a><span class="tsd-signature-symbol">&gt;</span></div>
524
+ <aside class="tsd-sources">
525
+ <ul>
526
+ <li>Defined in api.ts:578</li>
527
+ </ul>
528
+ </aside>
529
+ <div class="tsd-comment tsd-typography">
530
+ <div class="lead">
531
+ <p>Groups to share the published report with. This field will be updated entirely if provided</p>
532
+ </div>
533
+ <dl class="tsd-comment-tags">
534
+ <dt>memberof</dt>
535
+ <dd><p>ReportTask</p>
536
+ </dd>
537
+ </dl>
538
+ </div>
539
+ </section>
540
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
541
+ <a name="variables" class="tsd-anchor"></a>
542
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> variables</h3>
543
+ <div class="tsd-signature tsd-kind-icon">variables<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><a href="_api_.reporttaskvariables.html" class="tsd-signature-type">ReportTaskVariables</a><span class="tsd-signature-symbol">&gt;</span></div>
544
+ <aside class="tsd-sources">
545
+ <ul>
546
+ <li>Defined in api.ts:554</li>
547
+ </ul>
548
+ </aside>
549
+ <div class="tsd-comment tsd-typography">
550
+ <dl class="tsd-comment-tags">
551
+ <dt>memberof</dt>
552
+ <dd><p>ReportTask</p>
553
+ </dd>
554
+ </dl>
555
+ </div>
556
+ </section>
557
+ </section>
558
+ </div>
559
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
560
+ <nav class="tsd-navigation primary">
561
+ <ul>
562
+ <li class="globals ">
563
+ <a href="../globals.html"><em>Globals</em></a>
564
+ </li>
565
+ <li class="label tsd-is-external">
566
+ <span>Internals</span>
567
+ </li>
568
+ <li class=" tsd-kind-module">
569
+ <a href="../modules/_index_.html">&quot;index&quot;</a>
570
+ </li>
571
+ <li class="label tsd-is-external">
572
+ <span>Externals</span>
573
+ </li>
574
+ <li class="current tsd-kind-module tsd-is-external">
575
+ <a href="../modules/_api_.html">&quot;api&quot;</a>
576
+ </li>
577
+ <li class=" tsd-kind-module tsd-is-external">
578
+ <a href="../modules/_base_.html">&quot;base&quot;</a>
579
+ </li>
580
+ <li class=" tsd-kind-module tsd-is-external">
581
+ <a href="../modules/_configuration_.html">&quot;configuration&quot;</a>
582
+ </li>
583
+ </ul>
584
+ </nav>
585
+ <nav class="tsd-navigation secondary menu-sticky">
586
+ <ul class="before-current">
587
+ </ul>
588
+ <ul class="current">
589
+ <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external">
590
+ <a href="_api_.reporttask.html" class="tsd-kind-icon">Report<wbr>Task</a>
591
+ <ul>
592
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
593
+ <a href="_api_.reporttask.html#at" class="tsd-kind-icon">at</a>
594
+ </li>
595
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
596
+ <a href="_api_.reporttask.html#averagetimetogenerate" class="tsd-kind-icon">average<wbr>Time<wbr>ToGenerate</a>
597
+ </li>
598
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
599
+ <a href="_api_.reporttask.html#customselection" class="tsd-kind-icon">custom<wbr>Selection</a>
600
+ </li>
601
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
602
+ <a href="_api_.reporttask.html#dataplatformwaittime" class="tsd-kind-icon">data<wbr>Platform<wbr>Wait<wbr>Time</a>
603
+ </li>
604
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
605
+ <a href="_api_.reporttask.html#email" class="tsd-kind-icon">email</a>
606
+ </li>
607
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
608
+ <a href="_api_.reporttask.html#enabled" class="tsd-kind-icon">enabled</a>
609
+ </li>
610
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
611
+ <a href="_api_.reporttask.html#endon" class="tsd-kind-icon">end<wbr>On</a>
612
+ </li>
613
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
614
+ <a href="_api_.reporttask.html#error" class="tsd-kind-icon">error</a>
615
+ </li>
616
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
617
+ <a href="_api_.reporttask.html#every" class="tsd-kind-icon">every</a>
618
+ </li>
619
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
620
+ <a href="_api_.reporttask.html#filtercycleid" class="tsd-kind-icon">filter<wbr>Cycle<wbr>Id</a>
621
+ </li>
622
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
623
+ <a href="_api_.reporttask.html#filtersets" class="tsd-kind-icon">filter<wbr>Sets</a>
624
+ </li>
625
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
626
+ <a href="_api_.reporttask.html#frequency" class="tsd-kind-icon">frequency</a>
627
+ </li>
628
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
629
+ <a href="_api_.reporttask.html#groupstosharewith" class="tsd-kind-icon">groups<wbr>ToShare<wbr>With</a>
630
+ </li>
631
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
632
+ <a href="_api_.reporttask.html#id" class="tsd-kind-icon">id</a>
633
+ </li>
634
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
635
+ <a href="_api_.reporttask.html#meta" class="tsd-kind-icon">meta</a>
636
+ </li>
637
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
638
+ <a href="_api_.reporttask.html#nextrunat" class="tsd-kind-icon">next<wbr>Run<wbr>At</a>
639
+ </li>
640
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
641
+ <a href="_api_.reporttask.html#starton" class="tsd-kind-icon">start<wbr>On</a>
642
+ </li>
643
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
644
+ <a href="_api_.reporttask.html#tags" class="tsd-kind-icon">tags</a>
645
+ </li>
646
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
647
+ <a href="_api_.reporttask.html#templateid" class="tsd-kind-icon">template<wbr>Id</a>
648
+ </li>
649
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
650
+ <a href="_api_.reporttask.html#title" class="tsd-kind-icon">title</a>
651
+ </li>
652
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
653
+ <a href="_api_.reporttask.html#userstosharewith" class="tsd-kind-icon">users<wbr>ToShare<wbr>With</a>
654
+ </li>
655
+ <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
656
+ <a href="_api_.reporttask.html#variables" class="tsd-kind-icon">variables</a>
657
+ </li>
658
+ </ul>
659
+ </li>
660
+ </ul>
661
+ <ul class="after-current">
662
+ </ul>
663
+ </nav>
664
+ </div>
665
+ </div>
666
+ </div>
667
+ <footer class="with-border-bottom">
668
+ <div class="container">
669
+ <h2>Legend</h2>
670
+ <div class="tsd-legend-group">
671
+ <ul class="tsd-legend">
672
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
673
+ </ul>
674
+ </div>
675
+ </div>
676
+ </footer>
677
+ <div class="container tsd-generator">
678
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
679
+ </div>
680
+ <div class="overlay"></div>
681
+ <script src="../assets/js/main.js"></script>
682
+ </body>
683
+ </html>