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

Comparing version 1.1.1 to 1.3.0

.readme/API.md

@@ -12,2 +12,3 @@ # API
     * [~getCrops(parameters, options)](#module_API..getCrops) ⇒ <code>Object</code>
+    * [~getModules(parameters, options)](#module_API..getModules) ⇒ <code>Object</code>
     * [~postSignupCheck(parameters, options)](#module_API..postSignupCheck) ⇒ <code>Object</code>
@@ -18,2 +19,4 @@ * [~postLostPassword(parameters, options)](#module_API..postLostPassword) ⇒ <code>Object</code>
     * [~postVerify(parameters, options)](#module_API..postVerify) ⇒ <code>Object</code>
+    * [~postPartnerTokenRequest(parameters, options)](#module_API..postPartnerTokenRequest) ⇒ <code>Object</code>
+    * [~postPartnerToken(parameters, options)](#module_API..postPartnerToken) ⇒ <code>Object</code>
     * [~getPartnerDevices(parameters, options)](#module_API..getPartnerDevices) ⇒ <code>Object</code>
@@ -43,2 +46,5 @@ * [~postUser(parameters, options)](#module_API..postUser) ⇒ <code>Object</code>
     * [~putUserDevice(parameters, options)](#module_API..putUserDevice) ⇒ <code>Object</code>
+    * [~getUserDeviceModules(parameters, options)](#module_API..getUserDeviceModules) ⇒ <code>Object</code>
+    * [~putUserDeviceModule(parameters, options)](#module_API..putUserDeviceModule) ⇒ <code>Object</code>
+    * [~deleteUserDeviceModule(parameters, options)](#module_API..deleteUserDeviceModule) ⇒ <code>Object</code>
     * [~putUserDeviceShares(parameters, options)](#module_API..putUserDeviceShares) ⇒ <code>Object</code>
@@ -95,2 +101,15 @@ * [~getUserDeviceStatistics(parameters, options)](#module_API..getUserDeviceStatistics) ⇒ <code>Object</code>
 
+<a name="module_API..getModules"></a>
+
+### API~getModules(parameters, options) ⇒ <code>Object</code>
+Get the modules
+
+**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) |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
 <a name="module_API..postSignupCheck"></a>
@@ -167,2 +186,34 @@
 
+<a name="module_API..postPartnerTokenRequest"></a>
+
+### API~postPartnerTokenRequest(parameters, options) ⇒ <code>Object</code>
+Request a user token
+
+**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>undefined</code> | Basic auth with API Client id and API Client Secret, |
+| parameters.partnerId | <code>number</code> | The partner organisation id, |
+| parameters.body | <code>object</code> | Request a user token |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
+<a name="module_API..postPartnerToken"></a>
+
+### API~postPartnerToken(parameters, options) ⇒ <code>Object</code>
+Create a user token
+
+**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>undefined</code> | Basic auth with API Client id and API Client Secret, |
+| parameters.partnerId | <code>number</code> | The partner organisation id, |
+| parameters.body | <code>object</code> | Create a user token |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
 <a name="module_API..getPartnerDevices"></a>
@@ -554,2 +605,53 @@
 
+<a name="module_API..getUserDeviceModules"></a>
+
+### API~getUserDeviceModules(parameters, options) ⇒ <code>Object</code>
+Get the modules a user activated on its device
+
+**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.userId | <code>number</code> | The user id, |
+| parameters.deviceId | <code>number</code> | The device id, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
+<a name="module_API..putUserDeviceModule"></a>
+
+### API~putUserDeviceModule(parameters, options) ⇒ <code>Object</code>
+Add a module to a user's device
+
+**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.userId | <code>number</code> | The user id, |
+| parameters.deviceId | <code>number</code> | The device id, |
+| parameters.moduleId | <code>number</code> | The module id, |
+| parameters.body | <code>object</code> | The module settings, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
+<a name="module_API..deleteUserDeviceModule"></a>
+
+### API~deleteUserDeviceModule(parameters, options) ⇒ <code>Object</code>
+Disable a module for a user's device
+
+**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.userId | <code>number</code> | The user id, |
+| parameters.deviceId | <code>number</code> | The device id, |
+| parameters.moduleId | <code>number</code> | The module id, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
 <a name="module_API..putUserDeviceShares"></a>
@@ -589,3 +691,4 @@
 | parameters.endDate | <code>string</code> | The statistics end date, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.patched | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes. |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -666,3 +769,4 @@
 | parameters.endDate | <code>string</code> | The statistics end date, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.patched | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes. |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -669,0 +773,0 @@

CHANGELOG.md

@@ -0,1 +1,22 @@
+<a name="1.3.0"></a>
+# [1.3.0](https://github.com/sencrop/sencrop-js-api-client/compare/v1.2.0...v1.3.0) (2018-01-24)
+
+
+### Features
+
+* **Swagger:** Add partner modules endpoints ([9c2df84](https://github.com/sencrop/sencrop-js-api-client/commit/9c2df84))
+* **Swagger:** Add the partners API endpoints ([9a826e5](https://github.com/sencrop/sencrop-js-api-client/commit/9a826e5))
+
+
+
+<a name="1.2.0"></a>
+# [1.2.0](https://github.com/sencrop/sencrop-js-api-client/compare/v1.1.1...v1.2.0) (2018-01-17)
+
+
+### Features
+
+* **Swagger:** Update the Swagger definition ([f3ad716](https://github.com/sencrop/sencrop-js-api-client/commit/f3ad716))
+
+
+
 <a name="1.1.1"></a>
@@ -2,0 +23,0 @@ ## [1.1.1](https://github.com/sencrop/sencrop-js-api-client/compare/v1.1.0...v1.1.1) (2017-11-30)

package.json

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

README.md

@@ -58,2 +58,3 @@ <!--
     * [~getCrops(parameters, options)](#module_API..getCrops) ⇒ <code>Object</code>
+    * [~getModules(parameters, options)](#module_API..getModules) ⇒ <code>Object</code>
     * [~postSignupCheck(parameters, options)](#module_API..postSignupCheck) ⇒ <code>Object</code>
@@ -64,2 +65,4 @@ * [~postLostPassword(parameters, options)](#module_API..postLostPassword) ⇒ <code>Object</code>
     * [~postVerify(parameters, options)](#module_API..postVerify) ⇒ <code>Object</code>
+    * [~postPartnerTokenRequest(parameters, options)](#module_API..postPartnerTokenRequest) ⇒ <code>Object</code>
+    * [~postPartnerToken(parameters, options)](#module_API..postPartnerToken) ⇒ <code>Object</code>
     * [~getPartnerDevices(parameters, options)](#module_API..getPartnerDevices) ⇒ <code>Object</code>
@@ -89,2 +92,5 @@ * [~postUser(parameters, options)](#module_API..postUser) ⇒ <code>Object</code>
     * [~putUserDevice(parameters, options)](#module_API..putUserDevice) ⇒ <code>Object</code>
+    * [~getUserDeviceModules(parameters, options)](#module_API..getUserDeviceModules) ⇒ <code>Object</code>
+    * [~putUserDeviceModule(parameters, options)](#module_API..putUserDeviceModule) ⇒ <code>Object</code>
+    * [~deleteUserDeviceModule(parameters, options)](#module_API..deleteUserDeviceModule) ⇒ <code>Object</code>
     * [~putUserDeviceShares(parameters, options)](#module_API..putUserDeviceShares) ⇒ <code>Object</code>
@@ -141,2 +147,15 @@ * [~getUserDeviceStatistics(parameters, options)](#module_API..getUserDeviceStatistics) ⇒ <code>Object</code>
 
+<a name="module_API..getModules"></a>
+
+### API~getModules(parameters, options) ⇒ <code>Object</code>
+Get the modules
+
+**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) |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
 <a name="module_API..postSignupCheck"></a>
@@ -213,2 +232,34 @@
 
+<a name="module_API..postPartnerTokenRequest"></a>
+
+### API~postPartnerTokenRequest(parameters, options) ⇒ <code>Object</code>
+Request a user token
+
+**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>undefined</code> | Basic auth with API Client id and API Client Secret, |
+| parameters.partnerId | <code>number</code> | The partner organisation id, |
+| parameters.body | <code>object</code> | Request a user token |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
+<a name="module_API..postPartnerToken"></a>
+
+### API~postPartnerToken(parameters, options) ⇒ <code>Object</code>
+Create a user token
+
+**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>undefined</code> | Basic auth with API Client id and API Client Secret, |
+| parameters.partnerId | <code>number</code> | The partner organisation id, |
+| parameters.body | <code>object</code> | Create a user token |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
 <a name="module_API..getPartnerDevices"></a>
@@ -600,2 +651,53 @@
 
+<a name="module_API..getUserDeviceModules"></a>
+
+### API~getUserDeviceModules(parameters, options) ⇒ <code>Object</code>
+Get the modules a user activated on its device
+
+**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.userId | <code>number</code> | The user id, |
+| parameters.deviceId | <code>number</code> | The device id, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
+<a name="module_API..putUserDeviceModule"></a>
+
+### API~putUserDeviceModule(parameters, options) ⇒ <code>Object</code>
+Add a module to a user's device
+
+**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.userId | <code>number</code> | The user id, |
+| parameters.deviceId | <code>number</code> | The device id, |
+| parameters.moduleId | <code>number</code> | The module id, |
+| parameters.body | <code>object</code> | The module settings, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
+<a name="module_API..deleteUserDeviceModule"></a>
+
+### API~deleteUserDeviceModule(parameters, options) ⇒ <code>Object</code>
+Disable a module for a user's device
+
+**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.userId | <code>number</code> | The user id, |
+| parameters.deviceId | <code>number</code> | The device id, |
+| parameters.moduleId | <code>number</code> | The module id, |
+| parameters.authorization | <code>string</code> | Authorization with Bearer mecanism |
+| options | <code>Object</code> | Options to override Axios request configuration |
+
 <a name="module_API..putUserDeviceShares"></a>
@@ -635,3 +737,4 @@
 | parameters.endDate | <code>string</code> | The statistics end date, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.patched | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes. |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -712,3 +815,4 @@
 | parameters.endDate | <code>string</code> | The statistics end date, |
-| parameters.measures | <code>array</code> | The measures to read |
+| parameters.measures | <code>array</code> | The measures to read, |
+| parameters.patched | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes. |
 | options | <code>Object</code> | Options to override Axios request configuration |
@@ -715,0 +819,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

Improved metrics

Total package byte prevSize

641180

increased by6.42%

Lines of code

12103

increased by9.64%

Number of lines in readme file

1115

increased by10.29%

No dependency changes