Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
sencrop-js-api-client
Advanced tools
sencrop-js-api-client - npm Package Compare versions
Comparing version 1.5.0 to 1.6.0
@@ -21,2 +21,3 @@ # API | ||
| * [~getPartnerDevices(parameters, options)](#module_API..getPartnerDevices) ⇒ <code>Object</code> | ||
| * [~putPartnerModuleParameters(parameters, options)](#module_API..putPartnerModuleParameters) ⇒ <code>Object</code> | ||
| * [~getUser(parameters, options)](#module_API..getUser) ⇒ <code>Object</code> | ||
@@ -34,2 +35,3 @@ * [~putUser(parameters, options)](#module_API..putUser) ⇒ <code>Object</code> | ||
| * [~postUserAggregation(parameters, options)](#module_API..postUserAggregation) ⇒ <code>Object</code> | ||
| * [~getUserAggregation(parameters, options)](#module_API..getUserAggregation) ⇒ <code>Object</code> | ||
| * [~putUserAggregation(parameters, options)](#module_API..putUserAggregation) ⇒ <code>Object</code> | ||
@@ -125,3 +127,3 @@ * [~deleteUserAggregation(parameters, options)](#module_API..deleteUserAggregation) ⇒ <code>Object</code> | ||
| | parameters | <code>Object</code> | The parameters to provide (destructured) | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, | | ||
| | [parameters.authorization] | <code>string</code> | Authorization with Bearer mecanism, | | ||
| | parameters.body | <code>object</code> | The email to check | | ||
@@ -235,2 +237,21 @@ | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..putPartnerModuleParameters"></a> | ||
| ### API~putPartnerModuleParameters(parameters, options) ⇒ <code>Object</code> | ||
| Update an partner module parameters | ||
| **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.partnerId | <code>number</code> | The partner organisation id, | | ||
| | 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 parameters, | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
| | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..getUser"></a> | ||
@@ -407,4 +428,4 @@ | ||
| | parameters.userId | <code>number</code> | The user id, | | ||
| | parameters.compute | <code>boolean</code> | Wether the aggregations should be computed, | | ||
| | parameters.patched | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes., | | ||
| | [parameters.compute] | <code>boolean</code> | Wether the aggregations should be computed, | | ||
| | [parameters.patched] | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes., | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
@@ -429,2 +450,20 @@ | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..getUserAggregation"></a> | ||
| ### API~getUserAggregation(parameters, options) ⇒ <code>Object</code> | ||
| Get a single user aggregation with statistics for graphs | ||
| **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.aggregationId | <code>string</code> | The aggregation id, | | ||
| | [parameters.interval] | <code>string</code> | The interval of data, | | ||
| | [parameters.patched] | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes., | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
| | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..putUserAggregation"></a> | ||
@@ -555,7 +594,7 @@ | ||
| | parameters.userId | <code>number</code> | The user id, | | ||
| | parameters.date | <code>string</code> | The status date, | | ||
| | 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., | | ||
| | parameters.limit | <code>number</code> | The number of items to retrieve, | | ||
| | parameters.start | <code>number</code> | The index in results, | | ||
| | [parameters.date] | <code>string</code> | The status date, | | ||
| | [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., | | ||
| | [parameters.limit] | <code>number</code> | The number of items to retrieve, | | ||
| | [parameters.start] | <code>number</code> | The index in results, | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
@@ -699,3 +738,3 @@ | options | <code>Object</code> | Options to override Axios request configuration | | ||
| | 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. | | ||
| | [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 | | ||
@@ -777,3 +816,3 @@ | ||
| | 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. | | ||
| | [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 | | ||
@@ -848,3 +887,3 @@ | ||
| | parameters.longitude | <code>number</code> | The longitude of the forecasts, | | ||
| | parameters.date | <code>string</code> | Date of the forecasts, | | ||
| | [parameters.date] | <code>string</code> | Date of the forecasts, | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
@@ -851,0 +890,0 @@ | options | <code>Object</code> | Options to override Axios request configuration | |
@@ -63,3 +63,5 @@ /* eslint no-console:0 */ | ||
| : parameter.type | ||
| }} parameters.${camelCase(parameter.name)} | ||
| }} ${parameter.required ? `` : `[`}parameters.${camelCase(parameter.name)}${ | ||
| parameter.required ? `` : `]` | ||
| } | ||
| * ${parameter.description}` | ||
@@ -66,0 +68,0 @@ )} |
@@ -15,2 +15,4 @@ 'use strict'; | ||
| API.host = 'api.sencrop.com'; | ||
| API.paths[operation.path][operation.method].tags = ( | ||
@@ -17,0 +19,0 @@ operation.tags || [] |
@@ -0,1 +1,13 @@ | ||
| <a name="1.6.0"></a> | ||
| # [1.6.0](https://github.com/sencrop/sencrop-js-api-client/compare/v1.5.0...v1.6.0) (2018-04-24) | ||
| ### Features | ||
| * **Build:** Flag default parameters for docs ([a1205c6](https://github.com/sencrop/sencrop-js-api-client/commit/a1205c6)), closes [#6](https://github.com/sencrop/sencrop-js-api-client/issues/6) | ||
| * **Swagger:** Set the right host at Swagger import ([33c901f](https://github.com/sencrop/sencrop-js-api-client/commit/33c901f)) | ||
| * **Swagger:** Update the Swagger file to the latest API version ([5b3cf27](https://github.com/sencrop/sencrop-js-api-client/commit/5b3cf27)) | ||
| <a name="1.5.0"></a> | ||
@@ -2,0 +14,0 @@ # [1.5.0](https://github.com/sencrop/sencrop-js-api-client/compare/v1.4.0...v1.5.0) (2018-04-03) |
| { | ||
| "name": "sencrop-js-api-client", | ||
| "version": "1.5.0", | ||
| "version": "1.6.0", | ||
| "description": "The Sencrop JavaScript API client", | ||
@@ -5,0 +5,0 @@ "main": "dist/src/index.js", |
@@ -67,2 +67,3 @@ <!-- | ||
| * [~getPartnerDevices(parameters, options)](#module_API..getPartnerDevices) ⇒ <code>Object</code> | ||
| * [~putPartnerModuleParameters(parameters, options)](#module_API..putPartnerModuleParameters) ⇒ <code>Object</code> | ||
| * [~getUser(parameters, options)](#module_API..getUser) ⇒ <code>Object</code> | ||
@@ -80,2 +81,3 @@ * [~putUser(parameters, options)](#module_API..putUser) ⇒ <code>Object</code> | ||
| * [~postUserAggregation(parameters, options)](#module_API..postUserAggregation) ⇒ <code>Object</code> | ||
| * [~getUserAggregation(parameters, options)](#module_API..getUserAggregation) ⇒ <code>Object</code> | ||
| * [~putUserAggregation(parameters, options)](#module_API..putUserAggregation) ⇒ <code>Object</code> | ||
@@ -171,3 +173,3 @@ * [~deleteUserAggregation(parameters, options)](#module_API..deleteUserAggregation) ⇒ <code>Object</code> | ||
| | parameters | <code>Object</code> | The parameters to provide (destructured) | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism, | | ||
| | [parameters.authorization] | <code>string</code> | Authorization with Bearer mecanism, | | ||
| | parameters.body | <code>object</code> | The email to check | | ||
@@ -281,2 +283,21 @@ | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..putPartnerModuleParameters"></a> | ||
| ### API~putPartnerModuleParameters(parameters, options) ⇒ <code>Object</code> | ||
| Update an partner module parameters | ||
| **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.partnerId | <code>number</code> | The partner organisation id, | | ||
| | 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 parameters, | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
| | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..getUser"></a> | ||
@@ -453,4 +474,4 @@ | ||
| | parameters.userId | <code>number</code> | The user id, | | ||
| | parameters.compute | <code>boolean</code> | Wether the aggregations should be computed, | | ||
| | parameters.patched | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes., | | ||
| | [parameters.compute] | <code>boolean</code> | Wether the aggregations should be computed, | | ||
| | [parameters.patched] | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes., | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
@@ -475,2 +496,20 @@ | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..getUserAggregation"></a> | ||
| ### API~getUserAggregation(parameters, options) ⇒ <code>Object</code> | ||
| Get a single user aggregation with statistics for graphs | ||
| **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.aggregationId | <code>string</code> | The aggregation id, | | ||
| | [parameters.interval] | <code>string</code> | The interval of data, | | ||
| | [parameters.patched] | <code>boolean</code> | Wether you want to get only original data or eventually patched ones to avoid holes., | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
| | options | <code>Object</code> | Options to override Axios request configuration | | ||
| <a name="module_API..putUserAggregation"></a> | ||
@@ -601,7 +640,7 @@ | ||
| | parameters.userId | <code>number</code> | The user id, | | ||
| | parameters.date | <code>string</code> | The status date, | | ||
| | 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., | | ||
| | parameters.limit | <code>number</code> | The number of items to retrieve, | | ||
| | parameters.start | <code>number</code> | The index in results, | | ||
| | [parameters.date] | <code>string</code> | The status date, | | ||
| | [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., | | ||
| | [parameters.limit] | <code>number</code> | The number of items to retrieve, | | ||
| | [parameters.start] | <code>number</code> | The index in results, | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
@@ -745,3 +784,3 @@ | options | <code>Object</code> | Options to override Axios request configuration | | ||
| | 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. | | ||
| | [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 | | ||
@@ -823,3 +862,3 @@ | ||
| | 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. | | ||
| | [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 | | ||
@@ -894,3 +933,3 @@ | ||
| | parameters.longitude | <code>number</code> | The longitude of the forecasts, | | ||
| | parameters.date | <code>string</code> | Date of the forecasts, | | ||
| | [parameters.date] | <code>string</code> | Date of the forecasts, | | ||
| | parameters.authorization | <code>string</code> | Authorization with Bearer mecanism | | ||
@@ -897,0 +936,0 @@ | options | <code>Object</code> | Options to override Axios request configuration | |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by2.34%
672849
- Lines of code
- increased by3.07%
12540
- Number of lines in readme file
- increased by3.43%
1176
No dependency changes