sencrop-js-api-client - npm Package Compare versions

Comparing version 1.3.2 to 1.4.0

.readme/API.md

@@ -21,3 +21,2 @@ # API
     * [~getPartnerDevices(parameters, options)](#module_API..getPartnerDevices) ⇒ <code>Object</code>
-    * [~postUser(parameters, options)](#module_API..postUser) ⇒ <code>Object</code>
     * [~getUser(parameters, options)](#module_API..getUser) ⇒ <code>Object</code>
@@ -37,7 +36,7 @@ * [~putUser(parameters, options)](#module_API..putUser) ⇒ <code>Object</code>
     * [~deleteUserAggregation(parameters, options)](#module_API..deleteUserAggregation) ⇒ <code>Object</code>
-    * [~getUserDisplays(parameters, options)](#module_API..getUserDisplays) ⇒ <code>Object</code>
-    * [~postUserDisplay(parameters, options)](#module_API..postUserDisplay) ⇒ <code>Object</code>
-    * [~getUserDisplay(parameters, options)](#module_API..getUserDisplay) ⇒ <code>Object</code>
-    * [~putUserDisplay(parameters, options)](#module_API..putUserDisplay) ⇒ <code>Object</code>
-    * [~deleteUserDisplay(parameters, options)](#module_API..deleteUserDisplay) ⇒ <code>Object</code>
+    * [~getUserDeviceGroups(parameters, options)](#module_API..getUserDeviceGroups) ⇒ <code>Object</code>
+    * [~postUserDeviceGroup(parameters, options)](#module_API..postUserDeviceGroup) ⇒ <code>Object</code>
+    * [~getUserDeviceGroup(parameters, options)](#module_API..getUserDeviceGroup) ⇒ <code>Object</code>
+    * [~putUserDeviceGroup(parameters, options)](#module_API..putUserDeviceGroup) ⇒ <code>Object</code>
+    * [~deleteUserDeviceGroup(parameters, options)](#module_API..deleteUserDeviceGroup) ⇒ <code>Object</code>
     * [~getUserDevices(parameters, options)](#module_API..getUserDevices) ⇒ <code>Object</code>
@@ -235,17 +234,2 @@ * [~postUserDevice(parameters, options)](#module_API..postUserDevice) ⇒ <code>Object</code>
 
-<a name="module_API..postUser"></a>
-
-### API~postUser(parameters, options) ⇒ <code>Object</code>
-Create a user.
-
-**Kind**: inner method of [<code>API</code>](#module_API)  
-**Returns**: <code>Object</code> - The HTTP response  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| parameters | <code>Object</code> | The parameters to provide (destructured) |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
-| parameters.body | <code>undefined</code> | The new user to create |
-| options | <code>Object</code> | Options to override Axios request configuration |
-
 <a name="module_API..getUser"></a>
@@ -476,6 +460,6 @@
 
-<a name="module_API..getUserDisplays"></a>
+<a name="module_API..getUserDeviceGroups"></a>
 
-### API~getUserDisplays(parameters, options) ⇒ <code>Object</code>
-Get a user's displays.
+### API~getUserDeviceGroups(parameters, options) ⇒ <code>Object</code>
+Get a user's devices groups.
 
@@ -492,6 +476,6 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 
-<a name="module_API..postUserDisplay"></a>
+<a name="module_API..postUserDeviceGroup"></a>
 
-### API~postUserDisplay(parameters, options) ⇒ <code>Object</code>
-Create a user's display.
+### API~postUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Create a user's device group.
 
@@ -506,9 +490,9 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
-| parameters.body | <code>object</code> | The user's display |
+| parameters.body | <code>object</code> | The user's device group |
 | options | <code>Object</code> | Options to override Axios request configuration |
 
-<a name="module_API..getUserDisplay"></a>
+<a name="module_API..getUserDeviceGroup"></a>
 
-### API~getUserDisplay(parameters, options) ⇒ <code>Object</code>
-Get a user's display.
+### API~getUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Get a user's devices group.
 
@@ -522,10 +506,10 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.userId | <code>number</code> | The user id, |
-| parameters.displayId | <code>number</code> | The display id, |
+| parameters.deviceGroupId | <code>number</code> | The device group id, |
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
 
-<a name="module_API..putUserDisplay"></a>
+<a name="module_API..putUserDeviceGroup"></a>
 
-### API~putUserDisplay(parameters, options) ⇒ <code>Object</code>
-Update a user's display.
+### API~putUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Update a user's device group.
 
@@ -539,11 +523,11 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.userId | <code>number</code> | The user id, |
-| parameters.displayId | <code>string</code> | The display id, |
+| parameters.deviceGroupId | <code>string</code> | The deviceGroup id, |
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
-| parameters.body | <code>object</code> | The user's display |
+| parameters.body | <code>object</code> | The user's device group |
 | options | <code>Object</code> | Options to override Axios request configuration |
 
-<a name="module_API..deleteUserDisplay"></a>
+<a name="module_API..deleteUserDeviceGroup"></a>
 
-### API~deleteUserDisplay(parameters, options) ⇒ <code>Object</code>
-Delete a user's display.
+### API~deleteUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Delete a user's device group.
 
@@ -557,3 +541,3 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.userId | <code>number</code> | The user id, |
-| parameters.displayId | <code>number</code> | The display id, |
+| parameters.deviceGroupId | <code>number</code> | The device group id, |
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
@@ -733,6 +717,6 @@ | options | <code>Object</code> | Options to override Axios request configuration |
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.beforeDate | <code>string</code> | The date before which the data starts being retrieved, |
 | parameters.size | <code>number</code> | The number of measures to retrieve, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -753,6 +737,6 @@
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.beforeDate | <code>string</code> | The date before which the data starts being retrieved, |
 | parameters.days | <code>number</code> | The number of days to retrieve, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -773,6 +757,6 @@
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.beforeDate | <code>string</code> | The date before which the data starts being retrieved, |
 | parameters.days | <code>number</code> | The number of days to retrieve, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -813,5 +797,5 @@
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.startDate | <code>string</code> | The statistics start date, |
-| parameters.endDate | <code>string</code> | The statistics end date |
+| parameters.endDate | <code>string</code> | The statistics end date, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -818,0 +802,0 @@

CHANGELOG.md

@@ -0,1 +1,11 @@
+<a name="1.4.0"></a>
+# [1.4.0](https://github.com/sencrop/sencrop-js-api-client/compare/v1.3.2...v1.4.0) (2018-03-09)
+
+
+### Features
+
+* **Swagger:** Update the Swagger file ([b116abf](https://github.com/sencrop/sencrop-js-api-client/commit/b116abf))
+
+
+
 <a name="1.3.2"></a>
@@ -2,0 +12,0 @@ ## [1.3.2](https://github.com/sencrop/sencrop-js-api-client/compare/v1.3.1...v1.3.2) (2018-02-23)

package.json

 {
   "name": "sencrop-js-api-client",
-  "version": "1.3.2",
+  "version": "1.4.0",
   "description": "The Sencrop JavaScript API client",
@@ -5,0 +5,0 @@ "main": "dist/src/index.js",

README.md

@@ -67,3 +67,2 @@ <!--
     * [~getPartnerDevices(parameters, options)](#module_API..getPartnerDevices) ⇒ <code>Object</code>
-    * [~postUser(parameters, options)](#module_API..postUser) ⇒ <code>Object</code>
     * [~getUser(parameters, options)](#module_API..getUser) ⇒ <code>Object</code>
@@ -83,7 +82,7 @@ * [~putUser(parameters, options)](#module_API..putUser) ⇒ <code>Object</code>
     * [~deleteUserAggregation(parameters, options)](#module_API..deleteUserAggregation) ⇒ <code>Object</code>
-    * [~getUserDisplays(parameters, options)](#module_API..getUserDisplays) ⇒ <code>Object</code>
-    * [~postUserDisplay(parameters, options)](#module_API..postUserDisplay) ⇒ <code>Object</code>
-    * [~getUserDisplay(parameters, options)](#module_API..getUserDisplay) ⇒ <code>Object</code>
-    * [~putUserDisplay(parameters, options)](#module_API..putUserDisplay) ⇒ <code>Object</code>
-    * [~deleteUserDisplay(parameters, options)](#module_API..deleteUserDisplay) ⇒ <code>Object</code>
+    * [~getUserDeviceGroups(parameters, options)](#module_API..getUserDeviceGroups) ⇒ <code>Object</code>
+    * [~postUserDeviceGroup(parameters, options)](#module_API..postUserDeviceGroup) ⇒ <code>Object</code>
+    * [~getUserDeviceGroup(parameters, options)](#module_API..getUserDeviceGroup) ⇒ <code>Object</code>
+    * [~putUserDeviceGroup(parameters, options)](#module_API..putUserDeviceGroup) ⇒ <code>Object</code>
+    * [~deleteUserDeviceGroup(parameters, options)](#module_API..deleteUserDeviceGroup) ⇒ <code>Object</code>
     * [~getUserDevices(parameters, options)](#module_API..getUserDevices) ⇒ <code>Object</code>
@@ -281,17 +280,2 @@ * [~postUserDevice(parameters, options)](#module_API..postUserDevice) ⇒ <code>Object</code>
 
-<a name="module_API..postUser"></a>
-
-### API~postUser(parameters, options) ⇒ <code>Object</code>
-Create a user.
-
-**Kind**: inner method of [<code>API</code>](#module_API)  
-**Returns**: <code>Object</code> - The HTTP response  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| parameters | <code>Object</code> | The parameters to provide (destructured) |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
-| parameters.body | <code>undefined</code> | The new user to create |
-| options | <code>Object</code> | Options to override Axios request configuration |
-
 <a name="module_API..getUser"></a>
@@ -522,6 +506,6 @@
 
-<a name="module_API..getUserDisplays"></a>
+<a name="module_API..getUserDeviceGroups"></a>
 
-### API~getUserDisplays(parameters, options) ⇒ <code>Object</code>
-Get a user's displays.
+### API~getUserDeviceGroups(parameters, options) ⇒ <code>Object</code>
+Get a user's devices groups.
 
@@ -538,6 +522,6 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 
-<a name="module_API..postUserDisplay"></a>
+<a name="module_API..postUserDeviceGroup"></a>
 
-### API~postUserDisplay(parameters, options) ⇒ <code>Object</code>
-Create a user's display.
+### API~postUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Create a user's device group.
 
@@ -552,9 +536,9 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
-| parameters.body | <code>object</code> | The user's display |
+| parameters.body | <code>object</code> | The user's device group |
 | options | <code>Object</code> | Options to override Axios request configuration |
 
-<a name="module_API..getUserDisplay"></a>
+<a name="module_API..getUserDeviceGroup"></a>
 
-### API~getUserDisplay(parameters, options) ⇒ <code>Object</code>
-Get a user's display.
+### API~getUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Get a user's devices group.
 
@@ -568,10 +552,10 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.userId | <code>number</code> | The user id, |
-| parameters.displayId | <code>number</code> | The display id, |
+| parameters.deviceGroupId | <code>number</code> | The device group id, |
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
 
-<a name="module_API..putUserDisplay"></a>
+<a name="module_API..putUserDeviceGroup"></a>
 
-### API~putUserDisplay(parameters, options) ⇒ <code>Object</code>
-Update a user's display.
+### API~putUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Update a user's device group.
 
@@ -585,11 +569,11 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.userId | <code>number</code> | The user id, |
-| parameters.displayId | <code>string</code> | The display id, |
+| parameters.deviceGroupId | <code>string</code> | The deviceGroup id, |
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
-| parameters.body | <code>object</code> | The user's display |
+| parameters.body | <code>object</code> | The user's device group |
 | options | <code>Object</code> | Options to override Axios request configuration |
 
-<a name="module_API..deleteUserDisplay"></a>
+<a name="module_API..deleteUserDeviceGroup"></a>
 
-### API~deleteUserDisplay(parameters, options) ⇒ <code>Object</code>
-Delete a user's display.
+### API~deleteUserDeviceGroup(parameters, options) ⇒ <code>Object</code>
+Delete a user's device group.
 
@@ -603,3 +587,3 @@ **Kind**: inner method of [<code>API</code>](#module_API)
 | parameters.userId | <code>number</code> | The user id, |
-| parameters.displayId | <code>number</code> | The display id, |
+| parameters.deviceGroupId | <code>number</code> | The device group id, |
 | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
@@ -779,6 +763,6 @@ | options | <code>Object</code> | Options to override Axios request configuration |
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.beforeDate | <code>string</code> | The date before which the data starts being retrieved, |
 | parameters.size | <code>number</code> | The number of measures to retrieve, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -799,6 +783,6 @@
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.beforeDate | <code>string</code> | The date before which the data starts being retrieved, |
 | parameters.days | <code>number</code> | The number of days to retrieve, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -819,6 +803,6 @@
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.beforeDate | <code>string</code> | The date before which the data starts being retrieved, |
 | parameters.days | <code>number</code> | The number of days to retrieve, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -859,5 +843,5 @@
 | parameters.deviceId | <code>number</code> | The device id, |
-| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, |
 | parameters.startDate | <code>string</code> | The statistics start date, |
-| parameters.endDate | <code>string</code> | The statistics end date |
+| parameters.endDate | <code>string</code> | The statistics end date, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -864,0 +848,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

654226

decreased by-0.58%

Lines of code

12073

decreased by-1.07%

Number of lines in readme file

1137

decreased by-1.39%

No dependency changes