twilio-taskrouter 2.0.0 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,11 @@
1
+ 2.0.1
2
+ ==========
3
+ New Features
4
+ ----------
5
+ - Added `virtualStartTime` as an optional parameter to `WorkerTaskOptions` so that the virtual start time of the task can be set when `Worker.createTask` method is called
6
+ - Added `setVirtualStartTime` method to update the virtual start time of a `Task`
7
+ - Added `transcribe` and `transcriptionConfiguration` options to `reservation.conference` method
8
+
1
9
  2.0.0
2
10
  ==========
3
11
  New Features
@@ -1157,7 +1157,7 @@
1157
1157
  <span class="jsdoc-message">
1158
1158
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
1159
1159
 
1160
- on 2023-09-28T07:41:55+00:00
1160
+ on 2023-11-13T10:48:18+00:00
1161
1161
 
1162
1162
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1163
1163
  </span>
@@ -1732,7 +1732,7 @@
1732
1732
  <span class="jsdoc-message">
1733
1733
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
1734
1734
 
1735
- on 2023-09-28T07:41:55+00:00
1735
+ on 2023-11-13T10:48:18+00:00
1736
1736
 
1737
1737
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1738
1738
  </span>
@@ -641,7 +641,7 @@
641
641
  <span class="jsdoc-message">
642
642
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
643
643
 
644
- on 2023-09-28T07:41:55+00:00
644
+ on 2023-11-13T10:48:18+00:00
645
645
 
646
646
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
647
647
  </span>
@@ -1341,7 +1341,7 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
1341
1341
  <span class="jsdoc-message">
1342
1342
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
1343
1343
 
1344
- on 2023-09-28T07:41:55+00:00
1344
+ on 2023-11-13T10:48:18+00:00
1345
1345
 
1346
1346
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1347
1347
  </span>
@@ -3929,7 +3929,7 @@ in the <a href="Worker.html">Worker</a>'s attributes for this call to go through
3929
3929
  <span class="jsdoc-message">
3930
3930
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
3931
3931
 
3932
- on 2023-09-28T07:41:55+00:00
3932
+ on 2023-11-13T10:48:18+00:00
3933
3933
 
3934
3934
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
3935
3935
  </span>
@@ -4291,7 +4291,7 @@ TaskSid of the created Task.</li>
4291
4291
  <span class="jsdoc-message">
4292
4292
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
4293
4293
 
4294
- on 2023-09-28T07:41:55+00:00
4294
+ on 2023-11-13T10:48:18+00:00
4295
4295
 
4296
4296
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
4297
4297
  </span>
@@ -625,6 +625,32 @@
625
625
  </tr>
626
626
 
627
627
 
628
+
629
+ <tr>
630
+
631
+ <td class="name"><code>virtualStartTime</code></td>
632
+
633
+
634
+ <td class="type">
635
+
636
+
637
+ <span class="param-type">Date</span>
638
+
639
+
640
+
641
+
642
+ </td>
643
+
644
+
645
+
646
+
647
+
648
+ <td class="description last"><p>Optionally set starting time of the <a href="Task.html">Task</a>, in cases where
649
+ the interaction between the customer and agents spans across multiple tasks. If not
650
+ provided, defaults to dateCreated.</p></td>
651
+ </tr>
652
+
653
+
628
654
  </tbody>
629
655
  </table>
630
656
  </dl>
@@ -1930,6 +1956,73 @@
1930
1956
 
1931
1957
 
1932
1958
 
1959
+
1960
+
1961
+
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+
1973
+
1974
+ </dl>
1975
+
1976
+
1977
+
1978
+ </dd>
1979
+
1980
+
1981
+
1982
+ <hr>
1983
+ <dt class="name" id="virtualStartTime">
1984
+ <h4 id="virtualStartTime"><span class="type-signature">&lt;readonly&gt; </span>virtualStartTime<span class="type-signature"> :Date</span></h4>
1985
+
1986
+
1987
+ </dt>
1988
+ <dd>
1989
+
1990
+
1991
+
1992
+ <h5>Type:</h5>
1993
+ <ul>
1994
+ <li>
1995
+
1996
+ <span class="param-type">Date</span>
1997
+
1998
+
1999
+
2000
+ </li>
2001
+ </ul>
2002
+
2003
+
2004
+
2005
+ <dl class="details">
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+
2012
+
2013
+
2014
+
2015
+
2016
+
2017
+
2018
+
2019
+
2020
+
2021
+
2022
+
2023
+
2024
+
2025
+
1933
2026
 
1934
2027
 
1935
2028
 
@@ -2845,6 +2938,160 @@
2845
2938
 
2846
2939
 
2847
2940
 
2941
+ </dd>
2942
+
2943
+
2944
+
2945
+ <hr>
2946
+ <dt>
2947
+ <h4 class="name" id="setVirtualStartTime"><span class="type-signature"></span>setVirtualStartTime(date)</h4>
2948
+
2949
+
2950
+ </dt>
2951
+ <dd>
2952
+
2953
+
2954
+ <div class="description">
2955
+ <p>Set virtual start time of the <a href="Task.html">Task</a>.</p>
2956
+ </div>
2957
+
2958
+
2959
+
2960
+
2961
+
2962
+
2963
+
2964
+
2965
+ <h5>Parameters:</h5>
2966
+
2967
+
2968
+ <table class="params table table-striped">
2969
+ <thead>
2970
+ <tr>
2971
+
2972
+ <th>Name</th>
2973
+
2974
+
2975
+ <th>Type</th>
2976
+
2977
+
2978
+
2979
+
2980
+
2981
+ <th class="last">Description</th>
2982
+ </tr>
2983
+ </thead>
2984
+
2985
+ <tbody>
2986
+
2987
+
2988
+ <tr>
2989
+
2990
+ <td class="name"><code>date</code></td>
2991
+
2992
+
2993
+ <td class="type">
2994
+
2995
+
2996
+ <span class="param-type">Date</span>
2997
+
2998
+
2999
+
3000
+
3001
+ </td>
3002
+
3003
+
3004
+
3005
+
3006
+
3007
+ <td class="description last"><p>Virtual start time as a Date.</p></td>
3008
+ </tr>
3009
+
3010
+
3011
+ </tbody>
3012
+ </table>
3013
+
3014
+
3015
+
3016
+
3017
+ <dl class="details">
3018
+
3019
+
3020
+
3021
+
3022
+
3023
+
3024
+
3025
+
3026
+
3027
+
3028
+
3029
+
3030
+
3031
+
3032
+
3033
+
3034
+
3035
+
3036
+
3037
+
3038
+
3039
+
3040
+
3041
+
3042
+
3043
+
3044
+
3045
+
3046
+
3047
+
3048
+
3049
+
3050
+
3051
+
3052
+
3053
+ </dl>
3054
+
3055
+
3056
+
3057
+
3058
+
3059
+
3060
+
3061
+
3062
+
3063
+
3064
+
3065
+
3066
+
3067
+ <h5>Returns:</h5>
3068
+
3069
+
3070
+ <div class="param-desc">
3071
+ <ul>
3072
+ <li>Rejected if fails to set the time.</li>
3073
+ </ul>
3074
+ </div>
3075
+
3076
+
3077
+
3078
+ <dl>
3079
+ <dt>
3080
+ Type
3081
+ </dt>
3082
+ <dd>
3083
+
3084
+ <span class="param-type">Promise.&lt;this&gt;</span>
3085
+
3086
+
3087
+
3088
+ </dd>
3089
+ </dl>
3090
+
3091
+
3092
+
3093
+
3094
+
2848
3095
  </dd>
2849
3096
 
2850
3097
 
@@ -4553,7 +4800,7 @@
4553
4800
  <span class="jsdoc-message">
4554
4801
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
4555
4802
 
4556
- on 2023-09-28T07:41:55+00:00
4803
+ on 2023-11-13T10:48:18+00:00
4557
4804
 
4558
4805
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
4559
4806
  </span>
@@ -1635,7 +1635,7 @@
1635
1635
  <span class="jsdoc-message">
1636
1636
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
1637
1637
 
1638
- on 2023-09-28T07:41:55+00:00
1638
+ on 2023-11-13T10:48:18+00:00
1639
1639
 
1640
1640
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1641
1641
  </span>
@@ -747,7 +747,7 @@
747
747
  <span class="jsdoc-message">
748
748
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
749
749
 
750
- on 2023-09-28T07:41:55+00:00
750
+ on 2023-11-13T10:48:18+00:00
751
751
 
752
752
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
753
753
  </span>
@@ -4149,7 +4149,7 @@ TaskSid of the created Task.</li>
4149
4149
  <span class="jsdoc-message">
4150
4150
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
4151
4151
 
4152
- on 2023-09-28T07:41:55+00:00
4152
+ on 2023-11-13T10:48:18+00:00
4153
4153
 
4154
4154
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
4155
4155
  </span>
@@ -1231,7 +1231,7 @@
1231
1231
  <span class="jsdoc-message">
1232
1232
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
1233
1233
 
1234
- on 2023-09-28T07:41:55+00:00
1234
+ on 2023-11-13T10:48:18+00:00
1235
1235
 
1236
1236
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1237
1237
  </span>
@@ -5346,7 +5346,7 @@ No more attempts on the <a href="OutgoingTransfer.html">OutgoingTransfer</a> wil
5346
5346
  <span class="jsdoc-message">
5347
5347
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
5348
5348
 
5349
- on 2023-09-28T07:41:55+00:00
5349
+ on 2023-11-13T10:48:17+00:00
5350
5350
 
5351
5351
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
5352
5352
  </span>
@@ -1794,6 +1794,82 @@ The options for conferenceTrim are: ['trim-silence', 'do-not-trim'].</p></td>
1794
1794
  </tr>
1795
1795
 
1796
1796
 
1797
+
1798
+ <tr>
1799
+
1800
+ <td class="name"><code>transcribe</code></td>
1801
+
1802
+
1803
+ <td class="type">
1804
+
1805
+
1806
+ <span class="param-type">boolean</span>
1807
+
1808
+
1809
+
1810
+
1811
+ </td>
1812
+
1813
+
1814
+ <td class="attributes">
1815
+
1816
+ &lt;optional&gt;<br>
1817
+
1818
+
1819
+
1820
+ </td>
1821
+
1822
+
1823
+
1824
+ <td class="default">
1825
+
1826
+ false
1827
+
1828
+ </td>
1829
+
1830
+
1831
+ <td class="description last"><p>Whether the call recording should be transcribed or not.</p></td>
1832
+ </tr>
1833
+
1834
+
1835
+
1836
+ <tr>
1837
+
1838
+ <td class="name"><code>transcriptionConfiguration</code></td>
1839
+
1840
+
1841
+ <td class="type">
1842
+
1843
+
1844
+ <span class="param-type">string</span>
1845
+
1846
+
1847
+
1848
+
1849
+ </td>
1850
+
1851
+
1852
+ <td class="attributes">
1853
+
1854
+ &lt;optional&gt;<br>
1855
+
1856
+
1857
+
1858
+ </td>
1859
+
1860
+
1861
+
1862
+ <td class="default">
1863
+
1864
+ null
1865
+
1866
+ </td>
1867
+
1868
+
1869
+ <td class="description last"><p>The SID or (unique) friendly name of the transcription configuration object to use.</p></td>
1870
+ </tr>
1871
+
1872
+
1797
1873
  </tbody>
1798
1874
  </table>
1799
1875
  </dl>
@@ -4247,6 +4323,46 @@ provided, defaults to 'default' channel.</p></td>
4247
4323
  </tr>
4248
4324
 
4249
4325
 
4326
+
4327
+ <tr>
4328
+
4329
+ <td class="name"><code>virtualStartTime</code></td>
4330
+
4331
+
4332
+ <td class="type">
4333
+
4334
+
4335
+ <span class="param-type">Date</span>
4336
+
4337
+
4338
+
4339
+
4340
+ </td>
4341
+
4342
+
4343
+ <td class="attributes">
4344
+
4345
+ &lt;optional&gt;<br>
4346
+
4347
+
4348
+
4349
+ </td>
4350
+
4351
+
4352
+
4353
+ <td class="default">
4354
+
4355
+ null
4356
+
4357
+ </td>
4358
+
4359
+
4360
+ <td class="description last"><p>Optional manually set starting time of the <a href="Task.html">Task</a>, in cases where
4361
+ the interaction between the customer and agents spans across multiple tasks. If not
4362
+ provided, defaults to dateCreated.</p></td>
4363
+ </tr>
4364
+
4365
+
4250
4366
  </tbody>
4251
4367
  </table>
4252
4368
  </dl>
@@ -4679,7 +4795,7 @@ provided, defaults to 'default' channel.</p></td>
4679
4795
  <span class="jsdoc-message">
4680
4796
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
4681
4797
 
4682
- on 2023-09-28T07:41:55+00:00
4798
+ on 2023-11-13T10:48:17+00:00
4683
4799
 
4684
4800
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
4685
4801
  </span>
@@ -255,7 +255,7 @@ request/contribution process, <a href="https://gun.io/blog/how-to-github-fork-br
255
255
  <span class="jsdoc-message">
256
256
  Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
257
257
 
258
- on 2023-09-28T07:41:55+00:00
258
+ on 2023-11-13T10:48:17+00:00
259
259
 
260
260
  using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
261
261
  </span>