@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
package/docs/classes/_configuration_.configuration.html ADDED
@@ -0,0 +1,345 @@
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>Configuration | @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/_configuration_.html">&quot;configuration&quot;</a>
60
+ </li>
61
+ <li>
62
+ <a href="_configuration_.configuration.html">Configuration</a>
63
+ </li>
64
+ </ul>
65
+ <h1>Class Configuration</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-hierarchy">
73
+ <h3>Hierarchy</h3>
74
+ <ul class="tsd-hierarchy">
75
+ <li>
76
+ <span class="target">Configuration</span>
77
+ </li>
78
+ </ul>
79
+ </section>
80
+ <section class="tsd-panel-group tsd-index-group">
81
+ <h2>Index</h2>
82
+ <section class="tsd-panel tsd-index-panel">
83
+ <div class="tsd-index-content">
84
+ <section class="tsd-index-section tsd-is-external">
85
+ <h3>Constructors</h3>
86
+ <ul class="tsd-index-list">
87
+ <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-external"><a href="_configuration_.configuration.html#constructor" class="tsd-kind-icon">constructor</a></li>
88
+ </ul>
89
+ </section>
90
+ <section class="tsd-index-section tsd-is-external">
91
+ <h3>Properties</h3>
92
+ <ul class="tsd-index-list">
93
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_configuration_.configuration.html#accesstoken" class="tsd-kind-icon">access<wbr>Token</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_configuration_.configuration.html#apikey" class="tsd-kind-icon">api<wbr>Key</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_configuration_.configuration.html#baseoptions" class="tsd-kind-icon">base<wbr>Options</a></li>
96
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_configuration_.configuration.html#basepath" class="tsd-kind-icon">base<wbr>Path</a></li>
97
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_configuration_.configuration.html#password" class="tsd-kind-icon">password</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_configuration_.configuration.html#username" class="tsd-kind-icon">username</a></li>
99
+ </ul>
100
+ </section>
101
+ </div>
102
+ </section>
103
+ </section>
104
+ <section class="tsd-panel-group tsd-member-group tsd-is-external">
105
+ <h2>Constructors</h2>
106
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
107
+ <a name="constructor" class="tsd-anchor"></a>
108
+ <h3>constructor</h3>
109
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
110
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Configuration<span class="tsd-signature-symbol">(</span>param<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_configuration_.configurationparameters.html" class="tsd-signature-type">ConfigurationParameters</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a></li>
111
+ </ul>
112
+ <ul class="tsd-descriptions">
113
+ <li class="tsd-description">
114
+ <aside class="tsd-sources">
115
+ <ul>
116
+ <li>Defined in configuration.ts:66</li>
117
+ </ul>
118
+ </aside>
119
+ <h4 class="tsd-parameters-title">Parameters</h4>
120
+ <ul class="tsd-parameters">
121
+ <li>
122
+ <h5><span class="tsd-flag ts-flagDefault value">Default value</span> param: <a href="../interfaces/_configuration_.configurationparameters.html" class="tsd-signature-type">ConfigurationParameters</a><span class="tsd-signature-symbol"> = {}</span></h5>
123
+ </li>
124
+ </ul>
125
+ <h4 class="tsd-returns-title">Returns <a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a></h4>
126
+ </li>
127
+ </ul>
128
+ </section>
129
+ </section>
130
+ <section class="tsd-panel-group tsd-member-group tsd-is-external">
131
+ <h2>Properties</h2>
132
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
133
+ <a name="accesstoken" class="tsd-anchor"></a>
134
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> access<wbr>Token</h3>
135
+ <div class="tsd-signature tsd-kind-icon">access<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, scopes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span></div>
136
+ <aside class="tsd-sources">
137
+ <ul>
138
+ <li>Defined in configuration.ts:52</li>
139
+ </ul>
140
+ </aside>
141
+ <div class="tsd-comment tsd-typography">
142
+ <div class="lead">
143
+ <p>parameter for oauth2 security</p>
144
+ </div>
145
+ <dl class="tsd-comment-tags">
146
+ <dt>param</dt>
147
+ <dd><p>security name</p>
148
+ </dd>
149
+ <dt>param</dt>
150
+ <dd><p>oauth2 scope</p>
151
+ </dd>
152
+ <dt>memberof</dt>
153
+ <dd><p>Configuration</p>
154
+ </dd>
155
+ </dl>
156
+ </div>
157
+ </section>
158
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
159
+ <a name="apikey" class="tsd-anchor"></a>
160
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key</h3>
161
+ <div class="tsd-signature tsd-kind-icon">api<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div>
162
+ <aside class="tsd-sources">
163
+ <ul>
164
+ <li>Defined in configuration.ts:31</li>
165
+ </ul>
166
+ </aside>
167
+ <div class="tsd-comment tsd-typography">
168
+ <div class="lead">
169
+ <p>parameter for apiKey security</p>
170
+ </div>
171
+ <dl class="tsd-comment-tags">
172
+ <dt>param</dt>
173
+ <dd><p>security name</p>
174
+ </dd>
175
+ <dt>memberof</dt>
176
+ <dd><p>Configuration</p>
177
+ </dd>
178
+ </dl>
179
+ </div>
180
+ </section>
181
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
182
+ <a name="baseoptions" class="tsd-anchor"></a>
183
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> base<wbr>Options</h3>
184
+ <div class="tsd-signature tsd-kind-icon">base<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
185
+ <aside class="tsd-sources">
186
+ <ul>
187
+ <li>Defined in configuration.ts:66</li>
188
+ </ul>
189
+ </aside>
190
+ <div class="tsd-comment tsd-typography">
191
+ <div class="lead">
192
+ <p>base options for axios calls</p>
193
+ </div>
194
+ <dl class="tsd-comment-tags">
195
+ <dt>memberof</dt>
196
+ <dd><p>Configuration</p>
197
+ </dd>
198
+ </dl>
199
+ </div>
200
+ </section>
201
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
202
+ <a name="basepath" class="tsd-anchor"></a>
203
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> base<wbr>Path</h3>
204
+ <div class="tsd-signature tsd-kind-icon">base<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
205
+ <aside class="tsd-sources">
206
+ <ul>
207
+ <li>Defined in configuration.ts:59</li>
208
+ </ul>
209
+ </aside>
210
+ <div class="tsd-comment tsd-typography">
211
+ <div class="lead">
212
+ <p>override base path</p>
213
+ </div>
214
+ <dl class="tsd-comment-tags">
215
+ <dt>memberof</dt>
216
+ <dd><p>Configuration</p>
217
+ </dd>
218
+ </dl>
219
+ </div>
220
+ </section>
221
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
222
+ <a name="password" class="tsd-anchor"></a>
223
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> password</h3>
224
+ <div class="tsd-signature tsd-kind-icon">password<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
225
+ <aside class="tsd-sources">
226
+ <ul>
227
+ <li>Defined in configuration.ts:45</li>
228
+ </ul>
229
+ </aside>
230
+ <div class="tsd-comment tsd-typography">
231
+ <div class="lead">
232
+ <p>parameter for basic security</p>
233
+ </div>
234
+ <dl class="tsd-comment-tags">
235
+ <dt>memberof</dt>
236
+ <dd><p>Configuration</p>
237
+ </dd>
238
+ </dl>
239
+ </div>
240
+ </section>
241
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external">
242
+ <a name="username" class="tsd-anchor"></a>
243
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> username</h3>
244
+ <div class="tsd-signature tsd-kind-icon">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
245
+ <aside class="tsd-sources">
246
+ <ul>
247
+ <li>Defined in configuration.ts:38</li>
248
+ </ul>
249
+ </aside>
250
+ <div class="tsd-comment tsd-typography">
251
+ <div class="lead">
252
+ <p>parameter for basic security</p>
253
+ </div>
254
+ <dl class="tsd-comment-tags">
255
+ <dt>memberof</dt>
256
+ <dd><p>Configuration</p>
257
+ </dd>
258
+ </dl>
259
+ </div>
260
+ </section>
261
+ </section>
262
+ </div>
263
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
264
+ <nav class="tsd-navigation primary">
265
+ <ul>
266
+ <li class="globals ">
267
+ <a href="../globals.html"><em>Globals</em></a>
268
+ </li>
269
+ <li class="label tsd-is-external">
270
+ <span>Internals</span>
271
+ </li>
272
+ <li class=" tsd-kind-module">
273
+ <a href="../modules/_index_.html">&quot;index&quot;</a>
274
+ </li>
275
+ <li class="label tsd-is-external">
276
+ <span>Externals</span>
277
+ </li>
278
+ <li class=" tsd-kind-module tsd-is-external">
279
+ <a href="../modules/_api_.html">&quot;api&quot;</a>
280
+ </li>
281
+ <li class=" tsd-kind-module tsd-is-external">
282
+ <a href="../modules/_base_.html">&quot;base&quot;</a>
283
+ </li>
284
+ <li class="current tsd-kind-module tsd-is-external">
285
+ <a href="../modules/_configuration_.html">&quot;configuration&quot;</a>
286
+ </li>
287
+ </ul>
288
+ </nav>
289
+ <nav class="tsd-navigation secondary menu-sticky">
290
+ <ul class="before-current">
291
+ </ul>
292
+ <ul class="current">
293
+ <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
294
+ <a href="_configuration_.configuration.html" class="tsd-kind-icon">Configuration</a>
295
+ <ul>
296
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-external">
297
+ <a href="_configuration_.configuration.html#constructor" class="tsd-kind-icon">constructor</a>
298
+ </li>
299
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
300
+ <a href="_configuration_.configuration.html#accesstoken" class="tsd-kind-icon">access<wbr>Token</a>
301
+ </li>
302
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
303
+ <a href="_configuration_.configuration.html#apikey" class="tsd-kind-icon">api<wbr>Key</a>
304
+ </li>
305
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
306
+ <a href="_configuration_.configuration.html#baseoptions" class="tsd-kind-icon">base<wbr>Options</a>
307
+ </li>
308
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
309
+ <a href="_configuration_.configuration.html#basepath" class="tsd-kind-icon">base<wbr>Path</a>
310
+ </li>
311
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
312
+ <a href="_configuration_.configuration.html#password" class="tsd-kind-icon">password</a>
313
+ </li>
314
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-external">
315
+ <a href="_configuration_.configuration.html#username" class="tsd-kind-icon">username</a>
316
+ </li>
317
+ </ul>
318
+ </li>
319
+ </ul>
320
+ <ul class="after-current">
321
+ <li class=" tsd-kind-interface tsd-parent-kind-module tsd-is-external">
322
+ <a href="../interfaces/_configuration_.configurationparameters.html" class="tsd-kind-icon">Configuration<wbr>Parameters</a>
323
+ </li>
324
+ </ul>
325
+ </nav>
326
+ </div>
327
+ </div>
328
+ </div>
329
+ <footer class="with-border-bottom">
330
+ <div class="container">
331
+ <h2>Legend</h2>
332
+ <div class="tsd-legend-group">
333
+ <ul class="tsd-legend">
334
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
335
+ </ul>
336
+ </div>
337
+ </div>
338
+ </footer>
339
+ <div class="container tsd-generator">
340
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
341
+ </div>
342
+ <div class="overlay"></div>
343
+ <script src="../assets/js/main.js"></script>
344
+ </body>
345
+ </html>