Skip to content

Commit 9115918

Browse files
citizensascitizensas
committed
4.3.0
1 parent ede38ea commit 9115918

7 files changed

Lines changed: 363 additions & 50 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
4.3.0 - August 31, 2017
2+
3+
* typings: fix headers key-value type (Sassoun Derderian)
4+
* feat: add support of passing custom headers (Sassoun Derderian)
5+
* augment saucelabs idle timeout (Sassoun Derderian)
6+
* chore(package): update karma to version 1.7.1 (greenkeeper[bot])
7+
* augment timeout durations (Sassoun Derderian)
8+
* if connect fails retry one more time (Sassoun Derderian)
9+
* remove connectOptions (Sassoun Derderian)
10+
* fix(package): update @types/node to version 8.0.26 (greenkeeper[bot])
11+
* chore(package): update should to version 12.0.0 (greenkeeper[bot])
12+
* chore(package): update ts-loader to version 2.3.4 (greenkeeper[bot])
13+
* chore(package): update tslint to version 5.7.0 (greenkeeper[bot])
14+
* chore(package): update karma-sauce-launcher to version 1.2.0 (greenkeeper[bot])
15+
116
4.2.0 - August 25, 2017
217

318
* feat: export ResponseHandler helper to use from outside of workfront-api (Sassoun Derderian)

‎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: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,7 @@ <h1>Class Api</h1>
7474
</div>
7575
<dl class="tsd-comment-tags">
7676
<dt>param</dt>
77-
<dd><p>An object with the following keys:<br/>
78-
<code>url</code> {String} - Required. A url to Workfront server (for example: <a href="http://localhost:8080">http://localhost:8080</a>)<br/>
79-
<code>version</code> {String} - Optional. Which version of api to use. At the moment of writing can be 1.0, 2.0, 3.0, 4.0. Pass &#39;unsupported&#39; to use Workfront latest API (maybe unstable).<br/>
80-
<code>alwaysUseGet</code> {Boolean} - Optional. Defaults to false. Will cause the api to make every request as a GET with params in the query string and add method=DESIRED_METHOD_TYPE in the query string. Some Workfront urls will have issues with PUT and DELETE calls if this value is false.<br/>
81-
<code>secureProtocol</code> {String} - Optional. Used only in https. The SSL method to use, e.g. TLSv1_method to force TLS version 1. The possible values depend on your installation of OpenSSL and are defined in the constant <a href="http://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_PROTOCOL_METHODS" class="external">SSL_METHODS</a>.</p>
77+
<dd><p>An object with the following keys:<br/></p>
8278
</dd>
8379
<dt>constructor</dt>
8480
<dd></dd>
@@ -150,19 +146,19 @@ <h2>Constructors</h2>
150146
<a name="constructor" class="tsd-anchor"></a>
151147
<h3>constructor</h3>
152148
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
153-
<li class="tsd-signature tsd-kind-icon">new <wbr>Api<span class="tsd-signature-symbol">(</span>config<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><a href="_api_.api.html" class="tsd-signature-type">Api</a></li>
149+
<li class="tsd-signature tsd-kind-icon">new <wbr>Api<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/_api_.iapiconfig.html" class="tsd-signature-type">IApiConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_api_.api.html" class="tsd-signature-type">Api</a></li>
154150
</ul>
155151
<ul class="tsd-descriptions">
156152
<li class="tsd-description">
157153
<aside class="tsd-sources">
158154
<ul>
159-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L59">Api.ts:59</a></li>
155+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L72">Api.ts:72</a></li>
160156
</ul>
161157
</aside>
162158
<h4 class="tsd-parameters-title">Parameters</h4>
163159
<ul class="tsd-parameters">
164160
<li>
165-
<h5>config: <span class="tsd-signature-type">any</span></h5>
161+
<h5>config: <a href="../interfaces/_api_.iapiconfig.html" class="tsd-signature-type">IApiConfig</a></h5>
166162
</li>
167163
</ul>
168164
<h4 class="tsd-returns-title">Returns <a href="_api_.api.html" class="tsd-signature-type">Api</a></h4>
@@ -178,7 +174,7 @@ <h3>_http<wbr>Options</h3>
178174
<div class="tsd-signature tsd-kind-icon">_http<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_api_.ihttpoptions.html" class="tsd-signature-type">IHttpOptions</a></div>
179175
<aside class="tsd-sources">
180176
<ul>
181-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L58">Api.ts:58</a></li>
177+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L71">Api.ts:71</a></li>
182178
</ul>
183179
</aside>
184180
</section>
@@ -188,7 +184,7 @@ <h3>server<wbr>AcceptsJSON</h3>
188184
<div class="tsd-signature tsd-kind-icon">server<wbr>AcceptsJSON<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
189185
<aside class="tsd-sources">
190186
<ul>
191-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L59">Api.ts:59</a></li>
187+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L72">Api.ts:72</a></li>
192188
</ul>
193189
</aside>
194190
</section>
@@ -205,7 +201,7 @@ <h3>clear<wbr>Api<wbr>Key</h3>
205201
<li class="tsd-description">
206202
<aside class="tsd-sources">
207203
<ul>
208-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L164">Api.ts:164</a></li>
204+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L177">Api.ts:177</a></li>
209205
</ul>
210206
</aside>
211207
<div class="tsd-comment tsd-typography">
@@ -234,7 +230,7 @@ <h3>copy</h3>
234230
<li class="tsd-description">
235231
<aside class="tsd-sources">
236232
<ul>
237-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L128">Api.ts:128</a></li>
233+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L141">Api.ts:141</a></li>
238234
</ul>
239235
</aside>
240236
<div class="tsd-comment tsd-typography">
@@ -293,7 +289,7 @@ <h3>count</h3>
293289
<li class="tsd-description">
294290
<aside class="tsd-sources">
295291
<ul>
296-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L152">Api.ts:152</a></li>
292+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L165">Api.ts:165</a></li>
297293
</ul>
298294
</aside>
299295
<div class="tsd-comment tsd-typography">
@@ -332,7 +328,7 @@ <h3>create</h3>
332328
<li class="tsd-description">
333329
<aside class="tsd-sources">
334330
<ul>
335-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L185">Api.ts:185</a></li>
331+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L198">Api.ts:198</a></li>
336332
</ul>
337333
</aside>
338334
<div class="tsd-comment tsd-typography">
@@ -378,7 +374,7 @@ <h3>edit</h3>
378374
<li class="tsd-description">
379375
<aside class="tsd-sources">
380376
<ul>
381-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L201">Api.ts:201</a></li>
377+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L214">Api.ts:214</a></li>
382378
</ul>
383379
</aside>
384380
<div class="tsd-comment tsd-typography">
@@ -430,7 +426,7 @@ <h3>execute</h3>
430426
<li class="tsd-description">
431427
<aside class="tsd-sources">
432428
<ul>
433-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L217">Api.ts:217</a></li>
429+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L230">Api.ts:230</a></li>
434430
</ul>
435431
</aside>
436432
<div class="tsd-comment tsd-typography">
@@ -482,7 +478,7 @@ <h3>get</h3>
482478
<li class="tsd-description">
483479
<aside class="tsd-sources">
484480
<ul>
485-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L240">Api.ts:240</a></li>
481+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L253">Api.ts:253</a></li>
486482
</ul>
487483
</aside>
488484
<div class="tsd-comment tsd-typography">
@@ -531,7 +527,7 @@ <h3>get<wbr>Api<wbr>Key</h3>
531527
<li class="tsd-description">
532528
<aside class="tsd-sources">
533529
<ul>
534-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L95">Api.ts:95</a></li>
530+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L108">Api.ts:108</a></li>
535531
</ul>
536532
</aside>
537533
<div class="tsd-comment tsd-typography">
@@ -574,7 +570,7 @@ <h3>login</h3>
574570
<li class="tsd-description">
575571
<aside class="tsd-sources">
576572
<ul>
577-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L267">Api.ts:267</a></li>
573+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L280">Api.ts:280</a></li>
578574
</ul>
579575
</aside>
580576
<div class="tsd-comment tsd-typography">
@@ -618,7 +614,7 @@ <h3>logout</h3>
618614
<li class="tsd-description">
619615
<aside class="tsd-sources">
620616
<ul>
621-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L279">Api.ts:279</a></li>
617+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L292">Api.ts:292</a></li>
622618
</ul>
623619
</aside>
624620
<div class="tsd-comment tsd-typography">
@@ -646,7 +642,7 @@ <h3>metadata</h3>
646642
<li class="tsd-description">
647643
<aside class="tsd-sources">
648644
<ul>
649-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L298">Api.ts:298</a></li>
645+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L311">Api.ts:311</a></li>
650646
</ul>
651647
</aside>
652648
<div class="tsd-comment tsd-typography">
@@ -680,7 +676,7 @@ <h3>named<wbr>Query</h3>
680676
<li class="tsd-description">
681677
<aside class="tsd-sources">
682678
<ul>
683-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L315">Api.ts:315</a></li>
679+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L328">Api.ts:328</a></li>
684680
</ul>
685681
</aside>
686682
<div class="tsd-comment tsd-typography">
@@ -732,7 +728,7 @@ <h3>remove</h3>
732728
<li class="tsd-description">
733729
<aside class="tsd-sources">
734730
<ul>
735-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L327">Api.ts:327</a></li>
731+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L340">Api.ts:340</a></li>
736732
</ul>
737733
</aside>
738734
<div class="tsd-comment tsd-typography">
@@ -778,7 +774,7 @@ <h3>report</h3>
778774
<li class="tsd-description">
779775
<aside class="tsd-sources">
780776
<ul>
781-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L347">Api.ts:347</a></li>
777+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L360">Api.ts:360</a></li>
782778
</ul>
783779
</aside>
784780
<div class="tsd-comment tsd-typography">
@@ -821,7 +817,7 @@ <h3>request</h3>
821817
<li class="tsd-description">
822818
<aside class="tsd-sources">
823819
<ul>
824-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L360">Api.ts:360</a></li>
820+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L373">Api.ts:373</a></li>
825821
</ul>
826822
</aside>
827823
<div class="tsd-comment tsd-typography">
@@ -870,7 +866,7 @@ <h3>search</h3>
870866
<li class="tsd-description">
871867
<aside class="tsd-sources">
872868
<ul>
873-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L448">Api.ts:448</a></li>
869+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L461">Api.ts:461</a></li>
874870
</ul>
875871
</aside>
876872
<div class="tsd-comment tsd-typography">
@@ -913,7 +909,7 @@ <h3>set<wbr>Api<wbr>Key</h3>
913909
<li class="tsd-description">
914910
<aside class="tsd-sources">
915911
<ul>
916-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L457">Api.ts:457</a></li>
912+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L470">Api.ts:470</a></li>
917913
</ul>
918914
</aside>
919915
<div class="tsd-comment tsd-typography">
@@ -947,7 +943,7 @@ <h3>set<wbr>SessionID</h3>
947943
<li class="tsd-description">
948944
<aside class="tsd-sources">
949945
<ul>
950-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L466">Api.ts:466</a></li>
946+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L479">Api.ts:479</a></li>
951947
</ul>
952948
</aside>
953949
<div class="tsd-comment tsd-typography">
@@ -983,7 +979,7 @@ <h3>upload<wbr>File<wbr>Content</h3>
983979
<li class="tsd-description">
984980
<aside class="tsd-sources">
985981
<ul>
986-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L492">Api.ts:492</a></li>
982+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L505">Api.ts:505</a></li>
987983
</ul>
988984
</aside>
989985
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1009,7 +1005,7 @@ <h3>upload<wbr>From<wbr>Stream</h3>
10091005
<li class="tsd-description">
10101006
<aside class="tsd-sources">
10111007
<ul>
1012-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L486">Api.ts:486</a></li>
1008+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L499">Api.ts:499</a></li>
10131009
</ul>
10141010
</aside>
10151011
<div class="tsd-comment tsd-typography">
@@ -1059,7 +1055,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Methods</h3>
10591055
<div class="tsd-signature tsd-kind-icon">Methods<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
10601056
<aside class="tsd-sources">
10611057
<ul>
1062-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L52">Api.ts:52</a></li>
1058+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L65">Api.ts:65</a></li>
10631059
</ul>
10641060
</aside>
10651061
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
@@ -1068,7 +1064,7 @@ <h3>DELETE</h3>
10681064
<div class="tsd-signature tsd-kind-icon">DELETE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;DELETE&quot;</span></div>
10691065
<aside class="tsd-sources">
10701066
<ul>
1071-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L55">Api.ts:55</a></li>
1067+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L68">Api.ts:68</a></li>
10721068
</ul>
10731069
</aside>
10741070
</section>
@@ -1078,7 +1074,7 @@ <h3>GET</h3>
10781074
<div class="tsd-signature tsd-kind-icon">GET<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;GET&quot;</span></div>
10791075
<aside class="tsd-sources">
10801076
<ul>
1081-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L53">Api.ts:53</a></li>
1077+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L66">Api.ts:66</a></li>
10821078
</ul>
10831079
</aside>
10841080
</section>
@@ -1088,7 +1084,7 @@ <h3>POST</h3>
10881084
<div class="tsd-signature tsd-kind-icon">POST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;POST&quot;</span></div>
10891085
<aside class="tsd-sources">
10901086
<ul>
1091-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L56">Api.ts:56</a></li>
1087+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L69">Api.ts:69</a></li>
10921088
</ul>
10931089
</aside>
10941090
</section>
@@ -1098,7 +1094,7 @@ <h3>PUT</h3>
10981094
<div class="tsd-signature tsd-kind-icon">PUT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;PUT&quot;</span></div>
10991095
<aside class="tsd-sources">
11001096
<ul>
1101-
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/d887cda/src/Api.ts#L54">Api.ts:54</a></li>
1097+
<li>Defined in <a href="https://github.com/Workfront/workfront-api/blob/ede38ea/src/Api.ts#L67">Api.ts:67</a></li>
11021098
</ul>
11031099
</aside>
11041100
</section>
@@ -1202,6 +1198,9 @@ <h3>PUT</h3>
12021198
</li>
12031199
</ul>
12041200
<ul class="after-current">
1201+
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
1202+
<a href="../interfaces/_api_.iapiconfig.html" class="tsd-kind-icon">IApi<wbr>Config</a>
1203+
</li>
12051204
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
12061205
<a href="../interfaces/_api_.ihttpoptions.html" class="tsd-kind-icon">IHttp<wbr>Options</a>
12071206
</li>

0 commit comments

Comments
 (0)