Skip to content

Commit 8b03aad

Browse files
citizensascitizensas
committed
4.6.0
1 parent 9e0bac5 commit 8b03aad

8 files changed

Lines changed: 113 additions & 62 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
4.6.0 - February 20, 2018
2+
3+
* chore: upgrade packages typescript@2.7.2 ts-loader@3.5.0 (Sassoun Derderian)
4+
* feat: add ability to send 'X-XSRF-TOKEN' header in requests (Vardan Hakobyan)
5+
* fix(package): update form-data to version 2.3.2 (greenkeeper[bot])
6+
* chore(package): update webpack to version 3.11.0 (greenkeeper[bot])
7+
* chore(package): update dateformat to version 3.0.3 (greenkeeper[bot])
8+
* chore: downgrade mocha (Sassoun Derderian)
9+
* chore: update dependencies (Sassoun Derderian)
10+
* chore(package): update execa to version 0.9.0 (greenkeeper[bot])
11+
112
4.5.0 - December 28, 2017
213

314
* chore: downgrade typedoc to generate docs without warnings (Sassoun Derderian)

‎docs/assets/js/search.js‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/_api_.api.html‎

Lines changed: 67 additions & 30 deletions
Large diffs are not rendered by default.

‎docs/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,14 +89,14 @@ <h2 id="documentation">Documentation</h2>
8989
<h2 id="examples">Examples</h2>
9090
<p>A number of examples can be found under <a href="examples">examples</a> directory. It includes examples for both <a href="examples/node">node</a> and <a href="examples/browser">browser</a> environments.<br>In order to run these examples clone a copy of workfront-api repository:</p>
9191
<pre><code>git <span class="hljs-keyword">clone</span> <span class="hljs-title">git</span>://github.com/Workfront/workfront-api.git
92-
</code></pre><h4 id="running-node-examples-node-examples">Running <a href="examples/node">node</a> examples</h4>
92+
</code></pre><h4 id="running-node-examples">Running <a href="examples/node">node</a> examples</h4>
9393
<p>First enter into <code>workfront-api</code> directory and install all the dependencies:</p>
9494
<pre><code><span class="hljs-built_in">cd</span> workfront-api
9595
npm install
9696
</code></pre><p>Use <code>node</code> to run the examples. For examples:</p>
9797
<pre><code><span class="hljs-keyword">node</span> <span class="hljs-title">examples</span>/<span class="hljs-keyword">node</span><span class="hljs-title">/get-user-count</span>.js
9898
</code></pre><p>Each example script outputs all its results into console and contains comments in the source code explaining what is happening in more details.</p>
99-
<h4 id="running-browser-examples-browser-examples">Running <a href="examples/browser">browser</a> examples</h4>
99+
<h4 id="running-browser-examples">Running <a href="examples/browser">browser</a> examples</h4>
100100
<p>To start supplied webserver type:</p>
101101
<pre><code><span class="hljs-built_in">npm</span> start
102102
</code></pre><p>Visit <a href="http://localhost:8000/examples/browser/">http://localhost:8000/examples/browser/</a> to see list of all examples available for browser.</p>
@@ -120,7 +120,7 @@ <h2 id="license">License</h2>
120120
<p>Copyright (c) 2015 Workfront</p>
121121
<p>Licensed under the Apache License, Version 2.0.
122122
See the top-level file <code>LICENSE</code> and
123-
(<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>).</p>
123+
(<a href="http://www.apache.org/licenses/LICENSE-2.0)">http://www.apache.org/licenses/LICENSE-2.0)</a>.</p>
124124
</div>
125125
</div>
126126
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">

‎docs/interfaces/_api_.iapiconfig.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> always<wbr>Use<wbr>Ge
100100
<div class="tsd-signature tsd-kind-icon">always<wbr>Use<wbr>Get<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L41">Api.ts:41</a></li>
103+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L42">Api.ts:42</a></li>
104104
</ul>
105105
</aside>
106106
</section>
@@ -110,7 +110,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key</h3>
110110
<div class="tsd-signature tsd-kind-icon">api<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L42">Api.ts:42</a></li>
113+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L43">Api.ts:43</a></li>
114114
</ul>
115115
</aside>
116116
</section>
@@ -120,7 +120,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
120120
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
121121
<aside class="tsd-sources">
122122
<ul>
123-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L43">Api.ts:43</a></li>
123+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L44">Api.ts:44</a></li>
124124
</ul>
125125
</aside>
126126
<div class="tsd-type-declaration">
@@ -138,7 +138,7 @@ <h3>url</h3>
138138
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L39">Api.ts:39</a></li>
141+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L40">Api.ts:40</a></li>
142142
</ul>
143143
</aside>
144144
</section>
@@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
148148
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149149
<aside class="tsd-sources">
150150
<ul>
151-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L40">Api.ts:40</a></li>
151+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L41">Api.ts:41</a></li>
152152
</ul>
153153
</aside>
154154
</section>
@@ -206,7 +206,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
206206
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
207207
<a href="../modules/_api_.html#tfields" class="tsd-kind-icon">TFields</a>
208208
</li>
209-
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
209+
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
210210
<a href="../modules/_api_.html#tsuccesshandler" class="tsd-kind-icon">TSuccess<wbr>Handler</a>
211211
</li>
212212
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">

‎docs/interfaces/_api_.ihttpoptions.html‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> always<wbr>Use<wbr>Ge
100100
<div class="tsd-signature tsd-kind-icon">always<wbr>Use<wbr>Get<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
101101
<aside class="tsd-sources">
102102
<ul>
103-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L32">Api.ts:32</a></li>
103+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L32">Api.ts:32</a></li>
104104
</ul>
105105
</aside>
106106
</section>
@@ -110,12 +110,15 @@ <h3>headers</h3>
110110
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
111111
<aside class="tsd-sources">
112112
<ul>
113-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L33">Api.ts:33</a></li>
113+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L33">Api.ts:33</a></li>
114114
</ul>
115115
</aside>
116116
<div class="tsd-type-declaration">
117117
<h4>Type declaration</h4>
118118
<ul class="tsd-parameters">
119+
<li class="tsd-parameter">
120+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> X-<wbr>XSRF-<wbr>TOKEN<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
121+
</li>
119122
<li class="tsd-parameter">
120123
<h5><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
121124
</li>
@@ -131,7 +134,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> method</h3>
131134
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132135
<aside class="tsd-sources">
133136
<ul>
134-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L30">Api.ts:30</a></li>
137+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L30">Api.ts:30</a></li>
135138
</ul>
136139
</aside>
137140
</section>
@@ -141,7 +144,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> path</h3>
141144
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
142145
<aside class="tsd-sources">
143146
<ul>
144-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L29">Api.ts:29</a></li>
147+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L29">Api.ts:29</a></li>
145148
</ul>
146149
</aside>
147150
</section>
@@ -151,7 +154,7 @@ <h3>url</h3>
151154
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
152155
<aside class="tsd-sources">
153156
<ul>
154-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L31">Api.ts:31</a></li>
157+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L31">Api.ts:31</a></li>
155158
</ul>
156159
</aside>
157160
</section>
@@ -209,7 +212,7 @@ <h3>url</h3>
209212
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
210213
<a href="../modules/_api_.html#tfields" class="tsd-kind-icon">TFields</a>
211214
</li>
212-
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
215+
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
213216
<a href="../modules/_api_.html#tsuccesshandler" class="tsd-kind-icon">TSuccess<wbr>Handler</a>
214217
</li>
215218
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">

‎docs/modules/_api_.html‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ <h3>Type aliases</h3>
102102
<ul class="tsd-index-list">
103103
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_api_.html#tfailurehandler" class="tsd-kind-icon">TFailure<wbr>Handler</a></li>
104104
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_api_.html#tfields" class="tsd-kind-icon">TFields</a></li>
105-
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_api_.html#tsuccesshandler" class="tsd-kind-icon">TSuccess<wbr>Handler</a></li>
105+
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter"><a href="_api_.html#tsuccesshandler" class="tsd-kind-icon">TSuccess<wbr>Handler</a></li>
106106
</ul>
107107
</section>
108108
<section class="tsd-index-section tsd-is-not-exported">
@@ -134,7 +134,7 @@ <h3>TFailure<wbr>Handler</h3>
134134
<div class="tsd-signature tsd-kind-icon">TFailure<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
135135
<aside class="tsd-sources">
136136
<ul>
137-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L548">Api.ts:548</a></li>
137+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L565">Api.ts:565</a></li>
138138
</ul>
139139
</aside>
140140
<div class="tsd-type-declaration">
@@ -165,17 +165,17 @@ <h3>TFields</h3>
165165
<div class="tsd-signature tsd-kind-icon">TFields<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L45">Api.ts:45</a></li>
168+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L46">Api.ts:46</a></li>
169169
</ul>
170170
</aside>
171171
</section>
172-
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
172+
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
173173
<a name="tsuccesshandler" class="tsd-anchor"></a>
174174
<h3>TSuccess<wbr>Handler</h3>
175175
<div class="tsd-signature tsd-kind-icon">TSuccess<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
176176
<aside class="tsd-sources">
177177
<ul>
178-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L547">Api.ts:547</a></li>
178+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L564">Api.ts:564</a></li>
179179
</ul>
180180
</aside>
181181
<div class="tsd-type-declaration">
@@ -205,11 +205,11 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
205205
<h2>Variables</h2>
206206
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
207207
<a name="globalscope" class="tsd-anchor"></a>
208-
<h3>Global<wbr>Scope</h3>
208+
<h3><span class="tsd-flag ts-flagConst">Const</span> Global<wbr>Scope</h3>
209209
<div class="tsd-signature tsd-kind-icon">Global<wbr>Scope<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> =&nbsp;Function(&#x27;return this&#x27;)()</span></div>
210210
<aside class="tsd-sources">
211211
<ul>
212-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L47">Api.ts:47</a></li>
212+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L48">Api.ts:48</a></li>
213213
</ul>
214214
</aside>
215215
</section>
@@ -218,15 +218,15 @@ <h3>Global<wbr>Scope</h3>
218218
<h2>Functions</h2>
219219
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
220220
<a name="querystringify" class="tsd-anchor"></a>
221-
<h3>query<wbr>Stringify</h3>
221+
<h3><span class="tsd-flag ts-flagConst">Const</span> query<wbr>Stringify</h3>
222222
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
223223
<li class="tsd-signature tsd-kind-icon">query<wbr>Stringify<span class="tsd-signature-symbol">(</span>params<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">string</span></li>
224224
</ul>
225225
<ul class="tsd-descriptions">
226226
<li class="tsd-description">
227227
<aside class="tsd-sources">
228228
<ul>
229-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L534">Api.ts:534</a></li>
229+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L551">Api.ts:551</a></li>
230230
</ul>
231231
</aside>
232232
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -244,11 +244,11 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
244244
<h2>Object literals</h2>
245245
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module">
246246
<a name="responsehandler" class="tsd-anchor"></a>
247-
<h3>Response<wbr>Handler</h3>
247+
<h3><span class="tsd-flag ts-flagConst">Const</span> Response<wbr>Handler</h3>
248248
<div class="tsd-signature tsd-kind-icon">Response<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
249249
<aside class="tsd-sources">
250250
<ul>
251-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L550">Api.ts:550</a></li>
251+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L567">Api.ts:567</a></li>
252252
</ul>
253253
</aside>
254254
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
@@ -261,7 +261,7 @@ <h3>failure</h3>
261261
<li class="tsd-description">
262262
<aside class="tsd-sources">
263263
<ul>
264-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L585">Api.ts:585</a></li>
264+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L602">Api.ts:602</a></li>
265265
</ul>
266266
</aside>
267267
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -284,7 +284,7 @@ <h3>success</h3>
284284
<li class="tsd-description">
285285
<aside class="tsd-sources">
286286
<ul>
287-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L554">Api.ts:554</a></li>
287+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L571">Api.ts:571</a></li>
288288
</ul>
289289
</aside>
290290
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -331,7 +331,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
331331
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
332332
<a href="_api_.html#tfields" class="tsd-kind-icon">TFields</a>
333333
</li>
334-
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
334+
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
335335
<a href="_api_.html#tsuccesshandler" class="tsd-kind-icon">TSuccess<wbr>Handler</a>
336336
</li>
337337
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "workfront-api",
3-
"version": "4.5.0",
3+
"version": "4.6.0",
44
"description": "A Workfront API for the Node.js and the Web",
55
"main": "dist/workfront.js",
66
"module": "es/index.js",

0 commit comments

Comments
 (0)