opengate-js 12.1.1 → 12.2.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 (56) hide show
  1. package/bower.json +1 -1
  2. package/dist/{opengate-api-bower-12.1.1.js → opengate-api-bower-12.2.0.js} +28 -18
  3. package/dist/opengate-api-bower-12.2.0.js.map +1 -0
  4. package/dist/{opengate-api-bower-12.1.1.min.js → opengate-api-bower-12.2.0.min.js} +34 -34
  5. package/dist/{opengate-api-bower-12.1.1.min.js.map → opengate-api-bower-12.2.0.min.js.map} +1 -1
  6. package/dist/src/GenericFinder.js +1 -0
  7. package/dist/src/GenericFinder.js.map +1 -1
  8. package/dist/src/provision/BaseProvision.js +2 -0
  9. package/dist/src/provision/BaseProvision.js.map +1 -1
  10. package/dist/src/searching/BaseSearch.js +1 -0
  11. package/dist/src/searching/BaseSearch.js.map +1 -1
  12. package/dist/src/searching/builder/HardwaresSearchBuilder.js +5 -5
  13. package/dist/src/searching/builder/HardwaresSearchBuilder.js.map +1 -1
  14. package/dist/src/users/Users.js +3 -3
  15. package/dist/src/util/NorthAmpliaREST.js +6 -0
  16. package/dist/src/util/NorthAmpliaREST.js.map +1 -1
  17. package/docs/ast/source/GenericFinder.js.json +4504 -4504
  18. package/docs/ast/source/provision/BaseProvision.js.json +9643 -9643
  19. package/docs/ast/source/searching/BaseSearch.js.json +7981 -7981
  20. package/docs/ast/source/searching/builder/HardwaresSearchBuilder.js.json +505 -505
  21. package/docs/ast/source/users/Users.js.json +7 -7
  22. package/docs/ast/source/util/NorthAmpliaREST.js.json +10803 -10803
  23. package/docs/class/src/GenericFinder.js~GenericFinder.html +10 -3
  24. package/docs/class/src/provision/BaseProvision.js~BaseProvision.html +19 -6
  25. package/docs/class/src/searching/BaseSearch.js~BaseSearch.html +15 -8
  26. package/docs/class/src/searching/builder/HardwaresSearchBuilder.js~HardwaresSearchBuilder.html +37 -2
  27. package/docs/class/src/searching/builder/SearchBuilder.js~SearchBuilder.html +2 -2
  28. package/docs/class/src/searching/builder/SearchWithSummaryBuilder.js~SearchWithSummaryBuilder.html +1 -1
  29. package/docs/class/src/users/Users.js~User.html +34 -34
  30. package/docs/class/src/util/NorthAmpliaREST.js~NorthAmpliaREST.html +61 -19
  31. package/docs/class/src/util/SouthAmpliaREST.js~SouthAmpliaREST.html +6 -6
  32. package/docs/coverage.json +2 -2
  33. package/docs/dump.json +189 -89
  34. package/docs/file/src/GenericFinder.js.html +1 -0
  35. package/docs/file/src/provision/BaseProvision.js.html +2 -0
  36. package/docs/file/src/searching/BaseSearch.js.html +1 -0
  37. package/docs/file/src/searching/builder/HardwaresSearchBuilder.js.html +2 -2
  38. package/docs/file/src/users/Users.js.html +2 -2
  39. package/docs/file/src/util/NorthAmpliaREST.js.html +6 -0
  40. package/docs/package.json +1 -1
  41. package/docs/script/search_index.js +6 -6
  42. package/docs/source.html +231 -231
  43. package/features/features/provision/analytics/create_delete_analytics.feature +0 -1
  44. package/features/features/provision/users/reset_password.feature +3 -3
  45. package/features/features/provision/users/reset_password_mock.feature +0 -1
  46. package/features/step_definitions/when_step_definitions.js +39 -37
  47. package/features/support/hooks.js +11 -10
  48. package/features/support/world.js +1 -2
  49. package/package.json +1 -1
  50. package/src/GenericFinder.js +1 -0
  51. package/src/provision/BaseProvision.js +2 -0
  52. package/src/searching/BaseSearch.js +1 -0
  53. package/src/searching/builder/HardwaresSearchBuilder.js +2 -2
  54. package/src/users/Users.js +2 -2
  55. package/src/util/NorthAmpliaREST.js +6 -0
  56. package/dist/opengate-api-bower-12.1.1.js.map +0 -1
@@ -293,6 +293,7 @@ export default class GenericFinder {
293
293
  * @param {string} source - Relative url where is located the resource.
294
294
  * @param {string} reponseJsonData - Relative url where is located the resource. Can be null
295
295
  * @param {string} error_not_found - String error which will be thrown on not_found error.
296
+ * @param {string} serviceBaseURL - base of the uri petition
296
297
  */
297
298
  constructor(ogapi, source, entity, error_not_found, serviceBaseURL) {
298
299
  this._api = ogapi.Napi;
@@ -291,6 +291,8 @@ export default class BaseProvision {
291
291
  * @param {!InternalOpenGateAPI} ogapi - this is ogapi instance
292
292
  * @param {!string} resource - this is a base url resource
293
293
  * @param {!number} [timeout] - timeout on request
294
+ * @param {array} requiredParameters
295
+ * @param {string} serviceBaseURL - base of the uri petition
294
296
  */
295
297
  constructor(ogapi, resource, timeout, requiredParameters = [], serviceBaseURL) {
296
298
  if (this.constructor === BaseProvision) {
@@ -294,6 +294,7 @@ export default class BaseSearch {
294
294
  * @param {!InternalOpenGateAPI} ogapi - this is ogapi instance
295
295
  * @param {!string} resource - this is a base url resource
296
296
  * @param {!number} [timeout] - timeout on request
297
+ * @param {string} serviceBaseURL - base of the uri petition
297
298
  */
298
299
  constructor(ogapi, resource, timeout, serviceBaseURL) {
299
300
  if (this.constructor === BaseSearch) {
@@ -280,7 +280,7 @@
280
280
  <div class="content" data-ice="content"><h1 data-ice="title">src/searching/builder/HardwaresSearchBuilder.js</h1>
281
281
  <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">&apos;use strict&apos;;
282
282
 
283
- import SearchBuilder from &apos;./SearchBuilder&apos;;
283
+ import SearchWithSummaryBuilder from &apos;./SearchWithSummaryBuilder&apos;;
284
284
  import FieldFinder from &apos;../../util/searchingFields/FieldFinder&apos;
285
285
 
286
286
  const BASE_URL = &apos;/catalog/hardwares&apos;;
@@ -288,7 +288,7 @@ const BASE_URL = &apos;/catalog/hardwares&apos;;
288
288
  * Defined a search over Devices
289
289
  * @example ogapi.devicesSearchBuilder()
290
290
  */
291
- export default class HardwaresSearchBuilder extends SearchBuilder {
291
+ export default class HardwaresSearchBuilder extends SearchWithSummaryBuilder {
292
292
  /**
293
293
  * @param {!InternalOpenGateAPI} parent - Instance of our InternalOpenGateAPI
294
294
  */
@@ -542,9 +542,9 @@ export default class User extends BaseProvision {
542
542
  * @property {function (result:object, statusCode:number)} then - When request it is OK
543
543
  * @property {function (error:string)} catch - When request it is NOK
544
544
  * @example
545
- * ogapi.usersBuilder().withEmail(example@example.es).withPassword(oldPassword).updatePassword(newPassword);
545
+ * ogapi.usersBuilder().withEmail(example@example.es).withPassword(oldPassword).changePassword(newPassword);
546
546
  */
547
- updatePassword(newPassword) {
547
+ changePassword(newPassword) {
548
548
  this._newPassword = newPassword;
549
549
  if (_.isEmpty(this._email) || _.isEmpty(this._password) || _.isEmpty(this._newPassword)) {
550
550
  throw new Error(&apos;OGAPI_USER_UPDATE_PASSWORD_PARAMETER_MUST_BE_DEFINED&apos;);
@@ -366,6 +366,7 @@ export default class NorthAmpliaREST {
366
366
  * @param {object} headers - headers of request
367
367
  * @param {object} parameters - parameters of request
368
368
  * @param {boolean} asBlob - response body as Blob
369
+ * @param {string} serviceBaseURL - base of the uri petition
369
370
  * @return {Promise}
370
371
  */
371
372
  get(url, timeout, headers, parameters, asBlob, serviceBaseURL) {
@@ -382,6 +383,7 @@ export default class NorthAmpliaREST {
382
383
  * @param {number} timeout - timeout in milliseconds
383
384
  * @param {object} headers - headers of request
384
385
  * @param {object} parameters - parameters of request
386
+ * @param {string} serviceBaseURL - base of the uri petition
385
387
  * @return {Promise}
386
388
  */
387
389
  patch(url, data, timeout, headers, parameters, serviceBaseURL) {
@@ -400,6 +402,7 @@ export default class NorthAmpliaREST {
400
402
  * @param {number} timeout - timeout in milliseconds
401
403
  * @param {object} headers - headers of request
402
404
  * @param {object} parameters - parameters of request
405
+ * @param {string} serviceBaseURL - base of the uri petition
403
406
  * @return {Promise}
404
407
  */
405
408
  post(url, data, timeout, headers, parameters, serviceBaseURL) {
@@ -420,6 +423,7 @@ export default class NorthAmpliaREST {
420
423
  * @param {number} timeout - timeout in milliseconds
421
424
  * @param {object} headers - headers of request
422
425
  * @param {object} parameters - parameters of request
426
+ * @param {string} serviceBaseURL - base of the uri petition
423
427
  * @return {Promise}
424
428
  */
425
429
  post_multipart(url, formData, events, timeout, headers, parameters, serviceBaseURL) {
@@ -480,6 +484,7 @@ export default class NorthAmpliaREST {
480
484
  * @param {number} timeout - timeout in milliseconds
481
485
  * @param {object} headers - headers of request
482
486
  * @param {object} parameters - parameters of request
487
+ * @param {string} serviceBaseURL - base of the uri petition
483
488
  * @return {Promise}
484
489
  */
485
490
  put(url, data, timeout, headers, parameters, serviceBaseURL) {
@@ -506,6 +511,7 @@ export default class NorthAmpliaREST {
506
511
  * @param {number} timeout - timeout in milliseconds
507
512
  * @param {object} headers - headers of request
508
513
  * @param {object} parameters - parameters of request
514
+ * @param {string} serviceBaseURL - base of the uri petition
509
515
  * @return {Promise}
510
516
  */
511
517
  put_multipart(url, formData, events, timeout, headers, parameters, serviceBaseURL) {
package/docs/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "opengate-js",
3
- "version": "12.1.1",
3
+ "version": "12.2.0",
4
4
  "description": "",
5
5
  "main": "dist/opengate-api-npm.js",
6
6
  "repository": {
@@ -10397,6 +10397,12 @@ window.esdocSearchIndex = [
10397
10397
  "src/users/Users.js",
10398
10398
  "file"
10399
10399
  ],
10400
+ [
10401
+ "src/users/users.js~user#changepassword",
10402
+ "class/src/users/Users.js~User.html#instance-method-changePassword",
10403
+ "src/users/Users.js~User#changePassword",
10404
+ "method"
10405
+ ],
10400
10406
  [
10401
10407
  "src/users/users.js~user#constructor",
10402
10408
  "class/src/users/Users.js~User.html#instance-constructor-constructor",
@@ -10415,12 +10421,6 @@ window.esdocSearchIndex = [
10415
10421
  "src/users/Users.js~User#updatePassword",
10416
10422
  "method"
10417
10423
  ],
10418
- [
10419
- "src/users/users.js~user#updatepassword",
10420
- "class/src/users/Users.js~User.html#instance-method-updatePassword",
10421
- "src/users/Users.js~User#updatePassword",
10422
- "method"
10423
- ],
10424
10424
  [
10425
10425
  "src/users/users.js~user#withcountrycode",
10426
10426
  "class/src/users/Users.js~User.html#instance-method-withCountryCode",