Skip to content

Commit a5e25b9

Browse files
bhovhannesbhovhannes
committed
4.8.0
1 parent b8fc475 commit a5e25b9

File tree

8 files changed

+994
-52
lines changed

8 files changed

+994
-52
lines changed

‎CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
4.8.0 - June 1, 2018
2+
3+
* chore: add tests (Hovhannes Babayan)
4+
* refactor: remove unneeded checks (Hovhannes Babayan)
5+
* chore: update comment (Hovhannes Babayan)
6+
* feat: make `isAtomic` parameter for `batch()` method optional (Hovhannes Babayan)
7+
* chore: remove comment (Hovhannes Babayan)
8+
* feat: add `batch()` method (Hovhannes Babayan)
9+
110
4.7.0 - May 31, 2018
211

312
* chore: fix test (Hovhannes Babayan)

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
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: 160 additions & 32 deletions
Large diffs are not rendered by default.

‎docs/interfaces/_api_.iapiconfig.html‎

Lines changed: 11 additions & 5 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/ac4d2c6/src/Api.ts#L42">Api.ts:42</a></li>
103+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L43">Api.ts:43</a></li>
113+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L44">Api.ts:44</a></li>
123+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L40">Api.ts:40</a></li>
141+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/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/ac4d2c6/src/Api.ts#L41">Api.ts:41</a></li>
151+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L41">Api.ts:41</a></li>
152152
</ul>
153153
</aside>
154154
</section>
@@ -197,6 +197,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
197197
</li>
198198
</ul>
199199
<ul class="after-current">
200+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
201+
<a href="_api_.ibatchapi.html" class="tsd-kind-icon">IBatch<wbr>Api</a>
202+
</li>
200203
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
201204
<a href="_api_.ihttpoptions.html" class="tsd-kind-icon">IHttp<wbr>Options</a>
202205
</li>
@@ -212,6 +215,9 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> version</h3>
212215
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
213216
<a href="../modules/_api_.html#globalscope" class="tsd-kind-icon">Global<wbr>Scope</a>
214217
</li>
218+
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
219+
<a href="../modules/_api_.html#batchapifactory" class="tsd-kind-icon">batch<wbr>Api<wbr>Factory</a>
220+
</li>
215221
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
216222
<a href="../modules/_api_.html#querystringify" class="tsd-kind-icon">query<wbr>Stringify</a>
217223
</li>

‎docs/interfaces/_api_.ibatchapi.html‎

Lines changed: 762 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/interfaces/_api_.ihttpoptions.html‎

Lines changed: 11 additions & 5 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/ac4d2c6/src/Api.ts#L32">Api.ts:32</a></li>
103+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L32">Api.ts:32</a></li>
104104
</ul>
105105
</aside>
106106
</section>
@@ -110,7 +110,7 @@ <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/ac4d2c6/src/Api.ts#L33">Api.ts:33</a></li>
113+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L33">Api.ts:33</a></li>
114114
</ul>
115115
</aside>
116116
<div class="tsd-type-declaration">
@@ -134,7 +134,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> method</h3>
134134
<div class="tsd-signature tsd-kind-icon">method<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
135135
<aside class="tsd-sources">
136136
<ul>
137-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L30">Api.ts:30</a></li>
137+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L30">Api.ts:30</a></li>
138138
</ul>
139139
</aside>
140140
</section>
@@ -144,7 +144,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> path</h3>
144144
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
145145
<aside class="tsd-sources">
146146
<ul>
147-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L29">Api.ts:29</a></li>
147+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L29">Api.ts:29</a></li>
148148
</ul>
149149
</aside>
150150
</section>
@@ -154,7 +154,7 @@ <h3>url</h3>
154154
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
155155
<aside class="tsd-sources">
156156
<ul>
157-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L31">Api.ts:31</a></li>
157+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L31">Api.ts:31</a></li>
158158
</ul>
159159
</aside>
160160
</section>
@@ -182,6 +182,9 @@ <h3>url</h3>
182182
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
183183
<a href="_api_.iapiconfig.html" class="tsd-kind-icon">IApi<wbr>Config</a>
184184
</li>
185+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
186+
<a href="_api_.ibatchapi.html" class="tsd-kind-icon">IBatch<wbr>Api</a>
187+
</li>
185188
</ul>
186189
<ul class="current">
187190
<li class="current tsd-kind-interface tsd-parent-kind-external-module">
@@ -218,6 +221,9 @@ <h3>url</h3>
218221
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
219222
<a href="../modules/_api_.html#globalscope" class="tsd-kind-icon">Global<wbr>Scope</a>
220223
</li>
224+
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
225+
<a href="../modules/_api_.html#batchapifactory" class="tsd-kind-icon">batch<wbr>Api<wbr>Factory</a>
226+
</li>
221227
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
222228
<a href="../modules/_api_.html#querystringify" class="tsd-kind-icon">query<wbr>Stringify</a>
223229
</li>

‎docs/modules/_api_.html‎

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ <h3>Classes</h3>
9494
<h3>Interfaces</h3>
9595
<ul class="tsd-index-list">
9696
<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>
97+
<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>
9798
<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>
9899
</ul>
99100
</section>
@@ -114,6 +115,7 @@ <h3>Variables</h3>
114115
<section class="tsd-index-section tsd-is-not-exported">
115116
<h3>Functions</h3>
116117
<ul class="tsd-index-list">
118+
<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>
117119
<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>
118120
</ul>
119121
</section>
@@ -134,7 +136,7 @@ <h3>TFailure<wbr>Handler</h3>
134136
<div class="tsd-signature tsd-kind-icon">TFailure<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
135137
<aside class="tsd-sources">
136138
<ul>
137-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L566">Api.ts:566</a></li>
139+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L693">Api.ts:693</a></li>
138140
</ul>
139141
</aside>
140142
<div class="tsd-type-declaration">
@@ -165,7 +167,7 @@ <h3>TFields</h3>
165167
<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>
166168
<aside class="tsd-sources">
167169
<ul>
168-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L46">Api.ts:46</a></li>
170+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L46">Api.ts:46</a></li>
169171
</ul>
170172
</aside>
171173
</section>
@@ -175,7 +177,7 @@ <h3>TSuccess<wbr>Handler</h3>
175177
<div class="tsd-signature tsd-kind-icon">TSuccess<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div>
176178
<aside class="tsd-sources">
177179
<ul>
178-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L565">Api.ts:565</a></li>
180+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L692">Api.ts:692</a></li>
179181
</ul>
180182
</aside>
181183
<div class="tsd-type-declaration">
@@ -209,13 +211,36 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Global<wbr>Scope</h3>
209211
<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>
210212
<aside class="tsd-sources">
211213
<ul>
212-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L48">Api.ts:48</a></li>
214+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L48">Api.ts:48</a></li>
213215
</ul>
214216
</aside>
215217
</section>
216218
</section>
217219
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
218220
<h2>Functions</h2>
221+
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
222+
<a name="batchapifactory" class="tsd-anchor"></a>
223+
<h3>batch<wbr>Api<wbr>Factory</h3>
224+
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
225+
<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>
226+
</ul>
227+
<ul class="tsd-descriptions">
228+
<li class="tsd-description">
229+
<aside class="tsd-sources">
230+
<ul>
231+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L645">Api.ts:645</a></li>
232+
</ul>
233+
</aside>
234+
<h4 class="tsd-parameters-title">Parameters</h4>
235+
<ul class="tsd-parameters">
236+
<li>
237+
<h5>api: <a href="../classes/_api_.api.html" class="tsd-signature-type">Api</a></h5>
238+
</li>
239+
</ul>
240+
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_api_.ibatchapi.html" class="tsd-signature-type">IBatchApi</a></h4>
241+
</li>
242+
</ul>
243+
</section>
219244
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
220245
<a name="querystringify" class="tsd-anchor"></a>
221246
<h3><span class="tsd-flag ts-flagConst">Const</span> query<wbr>Stringify</h3>
@@ -226,7 +251,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> query<wbr>Stringify</h3>
226251
<li class="tsd-description">
227252
<aside class="tsd-sources">
228253
<ul>
229-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L552">Api.ts:552</a></li>
254+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L614">Api.ts:614</a></li>
230255
</ul>
231256
</aside>
232257
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -248,7 +273,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Response<wbr>Handler</h3>
248273
<div class="tsd-signature tsd-kind-icon">Response<wbr>Handler<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
249274
<aside class="tsd-sources">
250275
<ul>
251-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L568">Api.ts:568</a></li>
276+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L695">Api.ts:695</a></li>
252277
</ul>
253278
</aside>
254279
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-object-literal">
@@ -261,7 +286,7 @@ <h3>failure</h3>
261286
<li class="tsd-description">
262287
<aside class="tsd-sources">
263288
<ul>
264-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L603">Api.ts:603</a></li>
289+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L730">Api.ts:730</a></li>
265290
</ul>
266291
</aside>
267292
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -284,7 +309,7 @@ <h3>success</h3>
284309
<li class="tsd-description">
285310
<aside class="tsd-sources">
286311
<ul>
287-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ac4d2c6/src/Api.ts#L572">Api.ts:572</a></li>
312+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/b8fc475/src/Api.ts#L699">Api.ts:699</a></li>
288313
</ul>
289314
</aside>
290315
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -322,6 +347,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
322347
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
323348
<a href="../interfaces/_api_.iapiconfig.html" class="tsd-kind-icon">IApi<wbr>Config</a>
324349
</li>
350+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
351+
<a href="../interfaces/_api_.ibatchapi.html" class="tsd-kind-icon">IBatch<wbr>Api</a>
352+
</li>
325353
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
326354
<a href="../interfaces/_api_.ihttpoptions.html" class="tsd-kind-icon">IHttp<wbr>Options</a>
327355
</li>
@@ -337,6 +365,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
337365
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-not-exported">
338366
<a href="_api_.html#globalscope" class="tsd-kind-icon">Global<wbr>Scope</a>
339367
</li>
368+
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
369+
<a href="_api_.html#batchapifactory" class="tsd-kind-icon">batch<wbr>Api<wbr>Factory</a>
370+
</li>
340371
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported">
341372
<a href="_api_.html#querystringify" class="tsd-kind-icon">query<wbr>Stringify</a>
342373
</li>

‎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.7.0",
3+
"version": "4.8.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)