@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/index.html ADDED
@@ -0,0 +1,145 @@
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>@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
+ </ul>
59
+ <h1>@connectreport/connectreport-js</h1>
60
+ </div>
61
+ </div>
62
+ </header>
63
+ <div class="container container-main">
64
+ <div class="row">
65
+ <div class="col-8 col-content">
66
+ <div class="tsd-panel tsd-typography">
67
+ <a href="#connectreportconnectreport-js22711" id="connectreportconnectreport-js22711" style="color: inherit; text-decoration: none;">
68
+ <h2>@connectreport/connectreport-js@2.27.11</h2>
69
+ </a>
70
+ <p><a href="https://connectreport.com/">ConnectReport</a> API Javascript library. </p>
71
+ <p>View the <a href="https://connectreport.com/api-reference.html">ConnectReport HTTP API Reference</a></p>
72
+ <p>Supported Environments</p>
73
+ <ul>
74
+ <li>Node.js</li>
75
+ <li>Webpack</li>
76
+ <li>Browserify</li>
77
+ </ul>
78
+ <p>Language level</p>
79
+ <ul>
80
+ <li>ES5 - you must have a Promises/A+ library installed</li>
81
+ <li>ES6</li>
82
+ </ul>
83
+ <p>Module system</p>
84
+ <ul>
85
+ <li>CommonJS</li>
86
+ <li>ES6 module system</li>
87
+ </ul>
88
+ <p>It can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via <code>package.json</code>. (<a href="http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html">Reference</a>)</p>
89
+ <a href="#consuming" id="consuming" style="color: inherit; text-decoration: none;">
90
+ <h3>Consuming</h3>
91
+ </a>
92
+ <p>navigate to the folder of your consuming project and run one of the following commands.</p>
93
+ <pre><code>npm install @connectreport/connectreport-<span class="hljs-symbol">js@</span><span class="hljs-number">2.27</span><span class="hljs-number">.11</span> --save</code></pre>
94
+ </div>
95
+ </div>
96
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
97
+ <nav class="tsd-navigation primary">
98
+ <ul>
99
+ <li class="globals ">
100
+ <a href="globals.html"><em>Globals</em></a>
101
+ </li>
102
+ <li class="label tsd-is-external">
103
+ <span>Internals</span>
104
+ </li>
105
+ <li class=" tsd-kind-module">
106
+ <a href="modules/_index_.html">&quot;index&quot;</a>
107
+ </li>
108
+ <li class="label tsd-is-external">
109
+ <span>Externals</span>
110
+ </li>
111
+ <li class=" tsd-kind-module tsd-is-external">
112
+ <a href="modules/_api_.html">&quot;api&quot;</a>
113
+ </li>
114
+ <li class=" tsd-kind-module tsd-is-external">
115
+ <a href="modules/_base_.html">&quot;base&quot;</a>
116
+ </li>
117
+ <li class=" tsd-kind-module tsd-is-external">
118
+ <a href="modules/_configuration_.html">&quot;configuration&quot;</a>
119
+ </li>
120
+ </ul>
121
+ </nav>
122
+ <nav class="tsd-navigation secondary menu-sticky">
123
+ <ul class="before-current">
124
+ </ul>
125
+ </nav>
126
+ </div>
127
+ </div>
128
+ </div>
129
+ <footer class="with-border-bottom">
130
+ <div class="container">
131
+ <h2>Legend</h2>
132
+ <div class="tsd-legend-group">
133
+ <ul class="tsd-legend">
134
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
135
+ </ul>
136
+ </div>
137
+ </div>
138
+ </footer>
139
+ <div class="container tsd-generator">
140
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
141
+ </div>
142
+ <div class="overlay"></div>
143
+ <script src="assets/js/main.js"></script>
144
+ </body>
145
+ </html>