opengate-js 12.7.1 → 12.9.0

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.
Files changed (35) hide show
  1. package/README.md +6 -2
  2. package/bower.json +1 -1
  3. package/dist/{opengate-api-bower-12.7.1.js → opengate-api-bower-12.9.0.js} +34 -11
  4. package/dist/opengate-api-bower-12.9.0.js.map +1 -0
  5. package/dist/{opengate-api-bower-12.7.1.min.js → opengate-api-bower-12.9.0.min.js} +4 -4
  6. package/dist/opengate-api-bower-12.9.0.min.js.map +1 -0
  7. package/dist/src/users/Users.js +25 -5
  8. package/dist/src/users/Users.js.map +1 -1
  9. package/dist/src/util/NorthAmpliaREST.js +4 -1
  10. package/dist/src/util/NorthAmpliaREST.js.map +1 -1
  11. package/docs/ast/source/users/Users.js.json +10778 -7746
  12. package/docs/ast/source/util/NorthAmpliaREST.js.json +1536 -935
  13. package/docs/class/src/users/Users.js~User.html +132 -23
  14. package/docs/coverage.json +4 -4
  15. package/docs/dump.json +607 -492
  16. package/docs/file/src/users/Users.js.html +25 -6
  17. package/docs/file/src/util/NorthAmpliaREST.js.html +4 -1
  18. package/docs/index.html +6 -2
  19. package/docs/package.json +4 -2
  20. package/docs/script/search_index.js +6 -0
  21. package/docs/source.html +228 -228
  22. package/features/features/provision/users/create_delete_user.feature +3 -2
  23. package/features/features/provision/users/find_user.feature +2 -2
  24. package/features/features/provision/users/reset_password.feature +2 -1
  25. package/features/features/provision/users/reset_password_mock.feature +2 -1
  26. package/features/features/provision/users/update_password.feature +70 -0
  27. package/features/features/provision/users/update_user.feature +5 -3
  28. package/features/step_definitions/given_step_definitions_using_model.js +4 -3
  29. package/features/support/create_provision_model.js +2 -1
  30. package/features/support/world.js +2 -0
  31. package/package.json +4 -2
  32. package/src/users/Users.js +25 -6
  33. package/src/util/NorthAmpliaREST.js +4 -1
  34. package/dist/opengate-api-bower-12.7.1.js.map +0 -1
  35. package/dist/opengate-api-bower-12.7.1.min.js.map +0 -1
@@ -279,13 +279,13 @@
279
279
  </nav>
280
280
 
281
281
  <div class="content" data-ice="content"><div class="header-notice">
282
- <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import User from &apos;<span><a href="file/src/users/Users.js.html#lineNumber14">opengate-js/src/users/Users.js</a></span>&apos;</code></pre></div>
282
+ <div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import User from &apos;<span><a href="file/src/users/Users.js.html#lineNumber15">opengate-js/src/users/Users.js</a></span>&apos;</code></pre></div>
283
283
  <span data-ice="access">public</span>
284
284
  <span data-ice="kind">class</span>
285
285
 
286
286
 
287
287
 
288
- <span data-ice="source">| <span><a href="file/src/users/Users.js.html#lineNumber14">source</a></span></span>
288
+ <span data-ice="source">| <span><a href="file/src/users/Users.js.html#lineNumber15">source</a></span></span>
289
289
  </div>
290
290
 
291
291
  <div class="self-detail detail">
@@ -401,14 +401,14 @@ This function updates a password of a user</p>
401
401
  <p>
402
402
 
403
403
 
404
- <span data-ice="name"><span><a href="class/src/users/Users.js~User.html#instance-method-login">login</a></span></span><span data-ice="signature">(email: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, password: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
404
+ <span data-ice="name"><span><a href="class/src/users/Users.js~User.html#instance-method-login">login</a></span></span><span data-ice="signature">(email: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, password: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, twoFaCode: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
405
405
  </p>
406
406
  </div>
407
407
  <div>
408
408
 
409
409
 
410
410
  <div data-ice="description"><p>This invoke a request to OpenGate North API and the callback is managed by promises
411
- This function get a JWT for user</p>
411
+ This function get a JWT for user with Two Factor Authorithation (optional)</p>
412
412
  </div>
413
413
  </div>
414
414
  </td>
@@ -481,6 +481,34 @@ This function updates a password of a user with a tokenId</p>
481
481
 
482
482
 
483
483
 
484
+ <span class="override" data-ice="override"></span>
485
+ </td>
486
+ <td>
487
+ <div>
488
+ <p>
489
+
490
+
491
+ <span data-ice="name"><span><a href="class/src/users/Users.js~User.html#instance-method-with2FaType">with2FaType</a></span></span><span data-ice="signature">(twoFaType: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>): <span><a href="class/src/users/Users.js~User.html">User</a></span></span>
492
+ </p>
493
+ </div>
494
+ <div>
495
+
496
+
497
+ <div data-ice="description"><p>Set the 2FaType attribute</p>
498
+ </div>
499
+ </div>
500
+ </td>
501
+ <td>
502
+
503
+
504
+ </td>
505
+ </tr>
506
+ <tr data-ice="target">
507
+ <td>
508
+ <span class="access" data-ice="access">public</span>
509
+
510
+
511
+
484
512
  <span class="override" data-ice="override"></span>
485
513
  </td>
486
514
  <td>
@@ -898,7 +926,7 @@ This function updates a entity of provision</p>
898
926
  <span class="right-info">
899
927
 
900
928
 
901
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber20">source</a></span></span>
929
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber21">source</a></span></span>
902
930
  </span>
903
931
  </h3>
904
932
 
@@ -962,7 +990,7 @@ This function updates a entity of provision</p>
962
990
  <span class="right-info">
963
991
 
964
992
 
965
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber242">source</a></span></span>
993
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber257">source</a></span></span>
966
994
  </span>
967
995
  </h3>
968
996
 
@@ -1063,11 +1091,11 @@ This function updates a password of a user</p>
1063
1091
 
1064
1092
 
1065
1093
 
1066
- <span data-ice="name">login</span><span data-ice="signature">(email: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, password: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
1094
+ <span data-ice="name">login</span><span data-ice="signature">(email: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, password: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>, twoFaCode: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span>): <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a></span></span>
1067
1095
  <span class="right-info">
1068
1096
 
1069
1097
 
1070
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber324">source</a></span></span>
1098
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber341">source</a></span></span>
1071
1099
  </span>
1072
1100
  </h3>
1073
1101
 
@@ -1075,7 +1103,7 @@ This function updates a password of a user</p>
1075
1103
 
1076
1104
 
1077
1105
  <div data-ice="description"><p>This invoke a request to OpenGate North API and the callback is managed by promises
1078
- This function get a JWT for user</p>
1106
+ This function get a JWT for user with Two Factor Authorithation (optional)</p>
1079
1107
  </div>
1080
1108
 
1081
1109
 
@@ -1102,6 +1130,13 @@ This function get a JWT for user</p>
1102
1130
  <td data-ice="description"><p>required field</p>
1103
1131
  </td>
1104
1132
  </tr>
1133
+ <tr data-ice="property" data-depth="0">
1134
+ <td data-ice="name" data-depth="0">twoFaCode</td>
1135
+ <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">String</a></span></td>
1136
+ <td data-ice="appendix"></td>
1137
+ <td data-ice="description"><p>optional field</p>
1138
+ </td>
1139
+ </tr>
1105
1140
  </tbody>
1106
1141
  </table>
1107
1142
  </div>
@@ -1158,7 +1193,8 @@ This function get a JWT for user</p>
1158
1193
 
1159
1194
  <div class="example-doc" data-ice="exampleDoc">
1160
1195
 
1161
- <pre class="prettyprint source-code"><code data-ice="exampleCode"> ogapi.usersBuilder().login(email, password);</code></pre>
1196
+ <pre class="prettyprint source-code"><code data-ice="exampleCode"> ogapi.usersBuilder().login(email, password);
1197
+ ogapi.usersBuilder().login(email, password, twoFaCode);</code></pre>
1162
1198
  </div>
1163
1199
  </div>
1164
1200
 
@@ -1179,7 +1215,7 @@ This function get a JWT for user</p>
1179
1215
  <span class="right-info">
1180
1216
 
1181
1217
 
1182
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber271">source</a></span></span>
1218
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber286">source</a></span></span>
1183
1219
  </span>
1184
1220
  </h3>
1185
1221
 
@@ -1268,7 +1304,7 @@ Sends a password recovery email</p>
1268
1304
  <span class="right-info">
1269
1305
 
1270
1306
 
1271
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber290">source</a></span></span>
1307
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber305">source</a></span></span>
1272
1308
  </span>
1273
1309
  </h3>
1274
1310
 
@@ -1367,6 +1403,79 @@ This function updates a password of a user with a tokenId</p>
1367
1403
 
1368
1404
 
1369
1405
 
1406
+ </div>
1407
+ <div class="detail" data-ice="detail">
1408
+ <h3 data-ice="anchor" id="instance-method-with2FaType">
1409
+ <span class="access" data-ice="access">public</span>
1410
+
1411
+
1412
+
1413
+
1414
+
1415
+ <span data-ice="name">with2FaType</span><span data-ice="signature">(twoFaType: <span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span>): <span><a href="class/src/users/Users.js~User.html">User</a></span></span>
1416
+ <span class="right-info">
1417
+
1418
+
1419
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber167">source</a></span></span>
1420
+ </span>
1421
+ </h3>
1422
+
1423
+
1424
+
1425
+
1426
+ <div data-ice="description"><p>Set the 2FaType attribute</p>
1427
+ </div>
1428
+
1429
+
1430
+
1431
+ <div data-ice="properties"><div data-ice="properties">
1432
+ <h4 data-ice="title">Params:</h4>
1433
+ <table class="params">
1434
+ <thead>
1435
+ <tr><td>Name</td><td>Type</td><td>Attribute</td><td>Description</td></tr>
1436
+ </thead>
1437
+ <tbody>
1438
+
1439
+ <tr data-ice="property" data-depth="0">
1440
+ <td data-ice="name" data-depth="0">twoFaType</td>
1441
+ <td data-ice="type"><span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></span></td>
1442
+ <td data-ice="appendix"></td>
1443
+ <td data-ice="description"><p>required field</p>
1444
+ </td>
1445
+ </tr>
1446
+ </tbody>
1447
+ </table>
1448
+ </div>
1449
+ </div>
1450
+
1451
+ <div class="return-params" data-ice="returnParams">
1452
+ <h4>Return:</h4>
1453
+ <table>
1454
+ <tbody>
1455
+ <tr>
1456
+ <td class="return-type" data-ice="returnType"><span><a href="class/src/users/Users.js~User.html">User</a></span></td>
1457
+
1458
+ </tr>
1459
+ </tbody>
1460
+ </table>
1461
+ <div data-ice="returnProperties">
1462
+ </div>
1463
+ </div>
1464
+
1465
+
1466
+
1467
+
1468
+
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1370
1479
  </div>
1371
1480
  <div class="detail" data-ice="detail">
1372
1481
  <h3 data-ice="anchor" id="instance-method-withCountryCode">
@@ -1380,7 +1489,7 @@ This function updates a password of a user with a tokenId</p>
1380
1489
  <span class="right-info">
1381
1490
 
1382
1491
 
1383
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber115">source</a></span></span>
1492
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber116">source</a></span></span>
1384
1493
  </span>
1385
1494
  </h3>
1386
1495
 
@@ -1453,7 +1562,7 @@ This function updates a password of a user with a tokenId</p>
1453
1562
  <span class="right-info">
1454
1563
 
1455
1564
 
1456
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber140">source</a></span></span>
1565
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber141">source</a></span></span>
1457
1566
  </span>
1458
1567
  </h3>
1459
1568
 
@@ -1526,7 +1635,7 @@ This function updates a password of a user with a tokenId</p>
1526
1635
  <span class="right-info">
1527
1636
 
1528
1637
 
1529
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber91">source</a></span></span>
1638
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber92">source</a></span></span>
1530
1639
  </span>
1531
1640
  </h3>
1532
1641
 
@@ -1599,7 +1708,7 @@ This function updates a password of a user with a tokenId</p>
1599
1708
  <span class="right-info">
1600
1709
 
1601
1710
 
1602
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber55">source</a></span></span>
1711
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber56">source</a></span></span>
1603
1712
  </span>
1604
1713
  </h3>
1605
1714
 
@@ -1672,7 +1781,7 @@ This function updates a password of a user with a tokenId</p>
1672
1781
  <span class="right-info">
1673
1782
 
1674
1783
 
1675
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber127">source</a></span></span>
1784
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber128">source</a></span></span>
1676
1785
  </span>
1677
1786
  </h3>
1678
1787
 
@@ -1745,7 +1854,7 @@ This function updates a password of a user with a tokenId</p>
1745
1854
  <span class="right-info">
1746
1855
 
1747
1856
 
1748
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber31">source</a></span></span>
1857
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber32">source</a></span></span>
1749
1858
  </span>
1750
1859
  </h3>
1751
1860
 
@@ -1818,7 +1927,7 @@ This function updates a password of a user with a tokenId</p>
1818
1927
  <span class="right-info">
1819
1928
 
1820
1929
 
1821
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber67">source</a></span></span>
1930
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber68">source</a></span></span>
1822
1931
  </span>
1823
1932
  </h3>
1824
1933
 
@@ -1891,7 +2000,7 @@ This function updates a password of a user with a tokenId</p>
1891
2000
  <span class="right-info">
1892
2001
 
1893
2002
 
1894
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber103">source</a></span></span>
2003
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber104">source</a></span></span>
1895
2004
  </span>
1896
2005
  </h3>
1897
2006
 
@@ -1964,7 +2073,7 @@ This function updates a password of a user with a tokenId</p>
1964
2073
  <span class="right-info">
1965
2074
 
1966
2075
 
1967
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber43">source</a></span></span>
2076
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber44">source</a></span></span>
1968
2077
  </span>
1969
2078
  </h3>
1970
2079
 
@@ -2037,7 +2146,7 @@ This function updates a password of a user with a tokenId</p>
2037
2146
  <span class="right-info">
2038
2147
 
2039
2148
 
2040
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber153">source</a></span></span>
2149
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber154">source</a></span></span>
2041
2150
  </span>
2042
2151
  </h3>
2043
2152
 
@@ -2110,7 +2219,7 @@ This function updates a password of a user with a tokenId</p>
2110
2219
  <span class="right-info">
2111
2220
 
2112
2221
 
2113
- <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber79">source</a></span></span>
2222
+ <span data-ice="source"><span><a href="file/src/users/Users.js.html#lineNumber80">source</a></span></span>
2114
2223
  </span>
2115
2224
  </h3>
2116
2225
 
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "coverage": "88.52%",
3
- "expectCount": 1298,
4
- "actualCount": 1149,
3
+ "expectCount": 1299,
4
+ "actualCount": 1150,
5
5
  "files": {
6
6
  "src/bundles/ACTION_ENUM.js": {
7
7
  "expectCount": 1,
@@ -1276,8 +1276,8 @@
1276
1276
  ]
1277
1277
  },
1278
1278
  "src/users/Users.js": {
1279
- "expectCount": 17,
1280
- "actualCount": 17,
1279
+ "expectCount": 18,
1280
+ "actualCount": 18,
1281
1281
  "undocumentLines": []
1282
1282
  },
1283
1283
  "src/users/UserFinder.js": {