@connectreport/connectreport-js 2.80.3 → 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/_api_.jobsapi.html ADDED
@@ -0,0 +1,311 @@
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>JobsApi | @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_.jobsapi.html">JobsApi</a>
63
+ </li>
64
+ </ul>
65
+ <h1>Class JobsApi</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
+ <div class="lead">
75
+ <p>JobsApi - object-oriented interface</p>
76
+ </div>
77
+ <dl class="tsd-comment-tags">
78
+ <dt>export</dt>
79
+ <dd></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
+ <a href="_base_.baseapi.html" class="tsd-signature-type">BaseAPI</a>
88
+ <ul class="tsd-hierarchy">
89
+ <li>
90
+ <span class="target">JobsApi</span>
91
+ </li>
92
+ </ul>
93
+ </li>
94
+ </ul>
95
+ </section>
96
+ <section class="tsd-panel-group tsd-index-group">
97
+ <h2>Index</h2>
98
+ <section class="tsd-panel tsd-index-panel">
99
+ <div class="tsd-index-content">
100
+ <section class="tsd-index-section tsd-is-inherited tsd-is-external">
101
+ <h3>Constructors</h3>
102
+ <ul class="tsd-index-list">
103
+ <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_api_.jobsapi.html#constructor" class="tsd-kind-icon">constructor</a></li>
104
+ </ul>
105
+ </section>
106
+ <section class="tsd-index-section tsd-is-inherited tsd-is-private-protected tsd-is-external">
107
+ <h3>Properties</h3>
108
+ <ul class="tsd-index-list">
109
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="_api_.jobsapi.html#axios" class="tsd-kind-icon">axios</a></li>
110
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="_api_.jobsapi.html#basepath" class="tsd-kind-icon">base<wbr>Path</a></li>
111
+ <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external"><a href="_api_.jobsapi.html#configuration" class="tsd-kind-icon">configuration</a></li>
112
+ </ul>
113
+ </section>
114
+ <section class="tsd-index-section tsd-is-external">
115
+ <h3>Methods</h3>
116
+ <ul class="tsd-index-list">
117
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_api_.jobsapi.html#getjob" class="tsd-kind-icon">get<wbr>Job</a></li>
118
+ </ul>
119
+ </section>
120
+ </div>
121
+ </section>
122
+ </section>
123
+ <section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external">
124
+ <h2>Constructors</h2>
125
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
126
+ <a name="constructor" class="tsd-anchor"></a>
127
+ <h3>constructor</h3>
128
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
129
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Jobs<wbr>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">?: </span><a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a>, basePath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, axios<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_api_.jobsapi.html" class="tsd-signature-type">JobsApi</a></li>
130
+ </ul>
131
+ <ul class="tsd-descriptions">
132
+ <li class="tsd-description">
133
+ <aside class="tsd-sources">
134
+ <p>Inherited from <a href="_base_.baseapi.html">BaseAPI</a>.<a href="_base_.baseapi.html#constructor">constructor</a></p>
135
+ <ul>
136
+ <li>Defined in base.ts:50</li>
137
+ </ul>
138
+ </aside>
139
+ <h4 class="tsd-parameters-title">Parameters</h4>
140
+ <ul class="tsd-parameters">
141
+ <li>
142
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> configuration: <a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a></h5>
143
+ </li>
144
+ <li>
145
+ <h5><span class="tsd-flag ts-flagDefault value">Default value</span> basePath: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></h5>
146
+ </li>
147
+ <li>
148
+ <h5><span class="tsd-flag ts-flagDefault value">Default value</span> axios: <span class="tsd-signature-type">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></h5>
149
+ </li>
150
+ </ul>
151
+ <h4 class="tsd-returns-title">Returns <a href="_api_.jobsapi.html" class="tsd-signature-type">JobsApi</a></h4>
152
+ </li>
153
+ </ul>
154
+ </section>
155
+ </section>
156
+ <section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected tsd-is-external">
157
+ <h2>Properties</h2>
158
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
159
+ <a name="axios" class="tsd-anchor"></a>
160
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> axios</h3>
161
+ <div class="tsd-signature tsd-kind-icon">axios<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span></div>
162
+ <aside class="tsd-sources">
163
+ <p>Inherited from <a href="_base_.baseapi.html">BaseAPI</a>.<a href="_base_.baseapi.html#axios">axios</a></p>
164
+ <ul>
165
+ <li>Defined in base.ts:52</li>
166
+ </ul>
167
+ </aside>
168
+ </section>
169
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
170
+ <a name="basepath" class="tsd-anchor"></a>
171
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> base<wbr>Path</h3>
172
+ <div class="tsd-signature tsd-kind-icon">base<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
173
+ <aside class="tsd-sources">
174
+ <p>Inherited from <a href="_base_.baseapi.html">BaseAPI</a>.<a href="_base_.baseapi.html#basepath">basePath</a></p>
175
+ <ul>
176
+ <li>Defined in base.ts:52</li>
177
+ </ul>
178
+ </aside>
179
+ </section>
180
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
181
+ <a name="configuration" class="tsd-anchor"></a>
182
+ <h3><span class="tsd-flag ts-flagProtected">Protected</span> configuration</h3>
183
+ <div class="tsd-signature tsd-kind-icon">configuration<span class="tsd-signature-symbol">:</span> <a href="_configuration_.configuration.html" class="tsd-signature-type">Configuration</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
184
+ <aside class="tsd-sources">
185
+ <p>Inherited from <a href="_base_.baseapi.html">BaseAPI</a>.<a href="_base_.baseapi.html#configuration">configuration</a></p>
186
+ <ul>
187
+ <li>Defined in base.ts:50</li>
188
+ </ul>
189
+ </aside>
190
+ </section>
191
+ </section>
192
+ <section class="tsd-panel-group tsd-member-group tsd-is-external">
193
+ <h2>Methods</h2>
194
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
195
+ <a name="getjob" class="tsd-anchor"></a>
196
+ <h3>get<wbr>Job</h3>
197
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
198
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Job<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</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">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_api_.job.html" class="tsd-signature-type">Job</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
199
+ </ul>
200
+ <ul class="tsd-descriptions">
201
+ <li class="tsd-description">
202
+ <aside class="tsd-sources">
203
+ <ul>
204
+ <li>Defined in api.ts:1901</li>
205
+ </ul>
206
+ </aside>
207
+ <div class="tsd-comment tsd-typography">
208
+ <div class="lead">
209
+ <p>Get the status of a queued job, including its status and result if available.</p>
210
+ </div>
211
+ <dl class="tsd-comment-tags">
212
+ <dt>summary</dt>
213
+ <dd><p>Get job</p>
214
+ </dd>
215
+ <dt>throws</dt>
216
+ <dd><p>{RequiredError}</p>
217
+ </dd>
218
+ <dt>memberof</dt>
219
+ <dd><p>JobsApi</p>
220
+ </dd>
221
+ </dl>
222
+ </div>
223
+ <h4 class="tsd-parameters-title">Parameters</h4>
224
+ <ul class="tsd-parameters">
225
+ <li>
226
+ <h5>id: <span class="tsd-signature-type">string</span></h5>
227
+ </li>
228
+ <li>
229
+ <h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">any</span></h5>
230
+ </li>
231
+ </ul>
232
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">AxiosResponse</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_api_.job.html" class="tsd-signature-type">Job</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
233
+ </li>
234
+ </ul>
235
+ </section>
236
+ </section>
237
+ </div>
238
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
239
+ <nav class="tsd-navigation primary">
240
+ <ul>
241
+ <li class="globals ">
242
+ <a href="../globals.html"><em>Globals</em></a>
243
+ </li>
244
+ <li class="label tsd-is-external">
245
+ <span>Internals</span>
246
+ </li>
247
+ <li class=" tsd-kind-module">
248
+ <a href="../modules/_index_.html">&quot;index&quot;</a>
249
+ </li>
250
+ <li class="label tsd-is-external">
251
+ <span>Externals</span>
252
+ </li>
253
+ <li class="current tsd-kind-module tsd-is-external">
254
+ <a href="../modules/_api_.html">&quot;api&quot;</a>
255
+ </li>
256
+ <li class=" tsd-kind-module tsd-is-external">
257
+ <a href="../modules/_base_.html">&quot;base&quot;</a>
258
+ </li>
259
+ <li class=" tsd-kind-module tsd-is-external">
260
+ <a href="../modules/_configuration_.html">&quot;configuration&quot;</a>
261
+ </li>
262
+ </ul>
263
+ </nav>
264
+ <nav class="tsd-navigation secondary menu-sticky">
265
+ <ul class="before-current">
266
+ </ul>
267
+ <ul class="current">
268
+ <li class="current tsd-kind-class tsd-parent-kind-module tsd-is-external">
269
+ <a href="_api_.jobsapi.html" class="tsd-kind-icon">Jobs<wbr>Api</a>
270
+ <ul>
271
+ <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited tsd-is-external">
272
+ <a href="_api_.jobsapi.html#constructor" class="tsd-kind-icon">constructor</a>
273
+ </li>
274
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
275
+ <a href="_api_.jobsapi.html#axios" class="tsd-kind-icon">axios</a>
276
+ </li>
277
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
278
+ <a href="_api_.jobsapi.html#basepath" class="tsd-kind-icon">base<wbr>Path</a>
279
+ </li>
280
+ <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected tsd-is-external">
281
+ <a href="_api_.jobsapi.html#configuration" class="tsd-kind-icon">configuration</a>
282
+ </li>
283
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
284
+ <a href="_api_.jobsapi.html#getjob" class="tsd-kind-icon">get<wbr>Job</a>
285
+ </li>
286
+ </ul>
287
+ </li>
288
+ </ul>
289
+ <ul class="after-current">
290
+ </ul>
291
+ </nav>
292
+ </div>
293
+ </div>
294
+ </div>
295
+ <footer class="with-border-bottom">
296
+ <div class="container">
297
+ <h2>Legend</h2>
298
+ <div class="tsd-legend-group">
299
+ <ul class="tsd-legend">
300
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
301
+ </ul>
302
+ </div>
303
+ </div>
304
+ </footer>
305
+ <div class="container tsd-generator">
306
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
307
+ </div>
308
+ <div class="overlay"></div>
309
+ <script src="../assets/js/main.js"></script>
310
+ </body>
311
+ </html>