Skip to content

Commit

Permalink
4.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bhovhannes committed Jun 1, 2018
1 parent b8fc475 commit a5e25b9
Show file tree
Hide file tree
Showing 8 changed files with 994 additions and 52 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
4.8.0 - June 1, 2018

* chore: add tests (Hovhannes Babayan)
* refactor: remove unneeded checks (Hovhannes Babayan)
* chore: update comment (Hovhannes Babayan)
* feat: make `isAtomic` parameter for `batch()` method optional (Hovhannes Babayan)
* chore: remove comment (Hovhannes Babayan)
* feat: add `batch()` method (Hovhannes Babayan)

4.7.0 - May 31, 2018

* chore: fix test (Hovhannes Babayan)
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

192 changes: 160 additions & 32 deletions docs/classes/_api_.api.html

Large diffs are not rendered by default.

16 changes: 11 additions & 5 deletions docs/interfaces/_api_.iapiconfig.html
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/ac4d2c6/src/Api.ts#L42">Api.ts:42</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L43">Api.ts:43</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L44">Api.ts:44</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L40">Api.ts:40</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L41">Api.ts:41</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L41">Api.ts:41</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -197,6 +197,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_api_.ibatchapi.html" class="tsd-kind-icon">IBatch<wbr>Api</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_api_.ihttpoptions.html" class="tsd-kind-icon">IHttp<wbr>Options</a>
</li>
Expand All @@ -212,6 +215,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_api_.html#globalscope" class="tsd-kind-icon">Global<wbr>Scope</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_api_.html#batchapifactory" class="tsd-kind-icon">batch<wbr>Api<wbr>Factory</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_api_.html#querystringify" class="tsd-kind-icon">query<wbr>Stringify</a>
</li>
Expand Down
762 changes: 762 additions & 0 deletions docs/interfaces/_api_.ibatchapi.html

Large diffs are not rendered by default.

16 changes: 11 additions & 5 deletions docs/interfaces/_api_.ihttpoptions.html
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/ac4d2c6/src/Api.ts#L32">Api.ts:32</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L32">Api.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -110,7 +110,7 @@ <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/ac4d2c6/src/Api.ts#L33">Api.ts:33</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L33">Api.ts:33</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -134,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/ac4d2c6/src/Api.ts#L30">Api.ts:30</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L30">Api.ts:30</a></li>
</ul>
</aside>
</section>
Expand All @@ -144,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/ac4d2c6/src/Api.ts#L29">Api.ts:29</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L29">Api.ts:29</a></li>
</ul>
</aside>
</section>
Expand All @@ -154,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/ac4d2c6/src/Api.ts#L31">Api.ts:31</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L31">Api.ts:31</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -182,6 +182,9 @@ <h3>url</h3>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_api_.iapiconfig.html" class="tsd-kind-icon">IApi<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="_api_.ibatchapi.html" class="tsd-kind-icon">IBatch<wbr>Api</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
Expand Down Expand Up @@ -218,6 +221,9 @@ <h3>url</h3>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_api_.html#globalscope" class="tsd-kind-icon">Global<wbr>Scope</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_api_.html#batchapifactory" class="tsd-kind-icon">batch<wbr>Api<wbr>Factory</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="../modules/_api_.html#querystringify" class="tsd-kind-icon">query<wbr>Stringify</a>
</li>
Expand Down
47 changes: 39 additions & 8 deletions docs/modules/_api_.html
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ <h3>Classes</h3>
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_api_.iapiconfig.html" class="tsd-kind-icon">IApi<wbr>Config</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_api_.ibatchapi.html" class="tsd-kind-icon">IBatch<wbr>Api</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_api_.ihttpoptions.html" class="tsd-kind-icon">IHttp<wbr>Options</a></li>
</ul>
</section>
Expand All @@ -114,6 +115,7 @@ <h3>Variables</h3>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_api_.html#batchapifactory" class="tsd-kind-icon">batch<wbr>Api<wbr>Factory</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_api_.html#querystringify" class="tsd-kind-icon">query<wbr>Stringify</a></li>
</ul>
</section>
Expand All @@ -134,7 +136,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/ac4d2c6/src/Api.ts#L566">Api.ts:566</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L693">Api.ts:693</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand Down Expand Up @@ -165,7 +167,7 @@ <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/ac4d2c6/src/Api.ts#L46">Api.ts:46</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L46">Api.ts:46</a></li>
</ul>
</aside>
</section>
Expand All @@ -175,7 +177,7 @@ <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/ac4d2c6/src/Api.ts#L565">Api.ts:565</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L692">Api.ts:692</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand Down Expand Up @@ -209,13 +211,36 @@ <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/ac4d2c6/src/Api.ts#L48">Api.ts:48</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L48">Api.ts:48</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a name="batchapifactory" class="tsd-anchor"></a>
<h3>batch<wbr>Api<wbr>Factory</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">batch<wbr>Api<wbr>Factory<span class="tsd-signature-symbol">(</span>api<span class="tsd-signature-symbol">: </span><a href="../classes/_api_.api.html" class="tsd-signature-type">Api</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_api_.ibatchapi.html" class="tsd-signature-type">IBatchApi</a></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/b8fc475/src/Api.ts#L645">Api.ts:645</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>api: <a href="../classes/_api_.api.html" class="tsd-signature-type">Api</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_api_.ibatchapi.html" class="tsd-signature-type">IBatchApi</a></h4>
</li>
</ul>
</section>
<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><span class="tsd-flag ts-flagConst">Const</span> query<wbr>Stringify</h3>
Expand All @@ -226,7 +251,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> query<wbr>Stringify</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L552">Api.ts:552</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L614">Api.ts:614</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -248,7 +273,7 @@ <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/ac4d2c6/src/Api.ts#L568">Api.ts:568</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L695">Api.ts:695</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
Expand All @@ -261,7 +286,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/ac4d2c6/src/Api.ts#L603">Api.ts:603</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L730">Api.ts:730</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -284,7 +309,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/ac4d2c6/src/Api.ts#L572">Api.ts:572</a></li>
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L699">Api.ts:699</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -322,6 +347,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_api_.iapiconfig.html" class="tsd-kind-icon">IApi<wbr>Config</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_api_.ibatchapi.html" class="tsd-kind-icon">IBatch<wbr>Api</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_api_.ihttpoptions.html" class="tsd-kind-icon">IHttp<wbr>Options</a>
</li>
Expand All @@ -337,6 +365,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_api_.html#globalscope" class="tsd-kind-icon">Global<wbr>Scope</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_api_.html#batchapifactory" class="tsd-kind-icon">batch<wbr>Api<wbr>Factory</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
<a href="_api_.html#querystringify" class="tsd-kind-icon">query<wbr>Stringify</a>
</li>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "workfront-api",
"version": "4.7.0",
"version": "4.8.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 a5e25b9

Please sign in to comment.