Skip to content

Commit

Permalink
4.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@citizensas
citizensas committed Feb 20, 2018
1 parent 1e0ac84 commit fe91623
Show file tree
Hide file tree
Showing 8 changed files with 113 additions and 62 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
4.6.0 - February 20, 2018

* chore: upgrade packages [email protected] [email protected] (Sassoun Derderian)
* feat: add ability to send 'X-XSRF-TOKEN' header in requests (Vardan Hakobyan)
* fix(package): update form-data to version 2.3.2 (greenkeeper[bot])
* chore(package): update webpack to version 3.11.0 (greenkeeper[bot])
* chore(package): update dateformat to version 3.0.3 (greenkeeper[bot])
* chore: downgrade mocha (Sassoun Derderian)
* chore: update dependencies (Sassoun Derderian)
* chore(package): update execa to version 0.9.0 (greenkeeper[bot])

4.5.0 - December 28, 2017

* chore: downgrade typedoc to generate docs without warnings (Sassoun Derderian)
Expand Down
4 changes: 2 additions & 2 deletions docs/assets/js/search.js
View file

Large diffs are not rendered by default.

97 changes: 67 additions & 30 deletions docs/classes/_api_.api.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,14 @@ <h2 id="documentation">Documentation</h2>
<h2 id="examples">Examples</h2>
<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>
<pre><code>git <span class="hljs-keyword">clone</span> <span class="hljs-title">git</span>://github.com/Workfront/workfront-api.git
</code></pre><h4 id="running-node-examples-node-examples">Running <a href="examples/node">node</a> examples</h4>
</code></pre><h4 id="running-node-examples">Running <a href="examples/node">node</a> examples</h4>
<p>First enter into <code>workfront-api</code> directory and install all the dependencies:</p>
<pre><code><span class="hljs-built_in">cd</span> workfront-api
npm install
</code></pre><p>Use <code>node</code> to run the examples. For examples:</p>
<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
</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>
<h4 id="running-browser-examples-browser-examples">Running <a href="examples/browser">browser</a> examples</h4>
<h4 id="running-browser-examples">Running <a href="examples/browser">browser</a> examples</h4>
<p>To start supplied webserver type:</p>
<pre><code><span class="hljs-built_in">npm</span> start
</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>
Expand All @@ -120,7 +120,7 @@ <h2 id="license">License</h2>
<p>Copyright (c) 2015 Workfront</p>
<p>Licensed under the Apache License, Version 2.0.
See the top-level file <code>LICENSE</code> and
(<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>).</p>
(<a href="http://www.apache.org/licenses/LICENSE-2.0)">http://www.apache.org/licenses/LICENSE-2.0)</a>.</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
Expand Down
12 changes: 6 additions & 6 deletions docs/interfaces/_api_.iapiconfig.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> always<wbr>Use<wbr>Ge
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L41">Api.ts:41</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L42">Api.ts:42</a></li>
</ul>
</aside>
</section>
Expand All @@ -110,7 +110,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> api<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">api<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L42">Api.ts:42</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L43">Api.ts:43</a></li>
</ul>
</aside>
</section>
Expand All @@ -120,7 +120,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> headers</h3>
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L43">Api.ts:43</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L44">Api.ts:44</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -138,7 +138,7 @@ <h3>url</h3>
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L39">Api.ts:39</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L40">Api.ts:40</a></li>
</ul>
</aside>
</section>
Expand All @@ -148,7 +148,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
<div class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L40">Api.ts:40</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L41">Api.ts:41</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -206,7 +206,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_api_.html#tfields" class="tsd-kind-icon">TFields</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../modules/_api_.html#tsuccesshandler" class="tsd-kind-icon">TSuccess<wbr>Handler</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
Expand Down
15 changes: 9 additions & 6 deletions docs/interfaces/_api_.ihttpoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> always<wbr>Use<wbr>Ge
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L32">Api.ts:32</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L32">Api.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -110,12 +110,15 @@ <h3>headers</h3>
<div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L33">Api.ts:33</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L33">Api.ts:33</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<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>
</li>
<li class="tsd-parameter">
<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>
</li>
Expand All @@ -131,7 +134,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> method</h3>
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L30">Api.ts:30</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L30">Api.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -141,7 +144,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L29">Api.ts:29</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L29">Api.ts:29</a></li>
</ul>
</aside>
</section>
Expand All @@ -151,7 +154,7 @@ <h3>url</h3>
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L31">Api.ts:31</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L31">Api.ts:31</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -209,7 +212,7 @@ <h3>url</h3>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="../modules/_api_.html#tfields" class="tsd-kind-icon">TFields</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../modules/_api_.html#tsuccesshandler" class="tsd-kind-icon">TSuccess<wbr>Handler</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
Expand Down
28 changes: 14 additions & 14 deletions docs/modules/_api_.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ <h3>Type aliases</h3>
<ul class="tsd-index-list">
<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>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_api_.html#tfields" class="tsd-kind-icon">TFields</a></li>
<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>
<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>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
Expand Down Expand Up @@ -134,7 +134,7 @@ <h3>TFailure<wbr>Handler</h3>
<div class="tsd-signature tsd-kind-icon">TFailure<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L548">Api.ts:548</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L565">Api.ts:565</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand Down Expand Up @@ -165,17 +165,17 @@ <h3>TFields</h3>
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L45">Api.ts:45</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L46">Api.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-has-type-parameter">
<a name="tsuccesshandler" class="tsd-anchor"></a>
<h3>TSuccess<wbr>Handler</h3>
<div class="tsd-signature tsd-kind-icon">TSuccess<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L547">Api.ts:547</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L564">Api.ts:564</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand Down Expand Up @@ -205,11 +205,11 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a name="globalscope" class="tsd-anchor"></a>
<h3>Global<wbr>Scope</h3>
<h3><span class="tsd-flag ts-flagConst">Const</span> Global<wbr>Scope</h3>
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L47">Api.ts:47</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L48">Api.ts:48</a></li>
</ul>
</aside>
</section>
Expand All @@ -218,15 +218,15 @@ <h3>Global<wbr>Scope</h3>
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="querystringify" class="tsd-anchor"></a>
<h3>query<wbr>Stringify</h3>
<h3><span class="tsd-flag ts-flagConst">Const</span> query<wbr>Stringify</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L534">Api.ts:534</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L551">Api.ts:551</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -244,11 +244,11 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<h2>Object literals</h2>
<section class="tsd-panel tsd-member tsd-kind-object-literal tsd-parent-kind-external-module">
<a name="responsehandler" class="tsd-anchor"></a>
<h3>Response<wbr>Handler</h3>
<h3><span class="tsd-flag ts-flagConst">Const</span> Response<wbr>Handler</h3>
<div class="tsd-signature tsd-kind-icon">Response<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L550">Api.ts:550</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L567">Api.ts:567</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
Expand All @@ -261,7 +261,7 @@ <h3>failure</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L585">Api.ts:585</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L602">Api.ts:602</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -284,7 +284,7 @@ <h3>success</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/a737355/src/Api.ts#L554">Api.ts:554</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/1e0ac84/src/Api.ts#L571">Api.ts:571</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -331,7 +331,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_api_.html#tfields" class="tsd-kind-icon">TFields</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<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>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "workfront-api",
"version": "4.5.0",
"version": "4.6.0",
"description": "A Workfront API for the Node.js and the Web",
"main": "dist/workfront.js",
"module": "es/index.js",
Expand Down

0 comments on commit fe91623

Please sign in to comment.