sencrop-js-api-client

sencrop-js-api-client

The Sencrop JavaScript API client

The Sencrop API provides a Swagger file as a documentation.

This project aims to provide a JavaScript API on its basis, automatically generated.

Usage

import API from 'sencrop-js-api-client';

API.getUserDeviceStatistics({
  authorization: 'Bearer yolo-token',
  startDate: '2014-07-01T00:00:00.000Z',
  endDate: '2017-07-21T00:00:00.000Z',
}, {
  // Here goes any Axios request configuration override
  // See: https://github.com/mzabriskie/axios#request-config
  timeout: 40000,
})
.then(response => {
  console.log({
    response,
  });
});

Development

To rebuild the API, erase the swagger file with a newer one and build the SDK again:

npm run import
npm run build
npm run compile

API

API

API to consume Sencrop data

Version: 1.0.0

• API
  • ~getPing(parameters, options) ⇒ Object
  • ~getCrops(parameters, options) ⇒ Object
  • ~getModules(parameters, options) ⇒ Object
  • ~postSignupCheck(parameters, options) ⇒ Object
  • ~postLostPassword(parameters, options) ⇒ Object
  • ~putPassword(parameters, options) ⇒ Object
  • ~postLogin(parameters, options) ⇒ Object
  • ~postVerify(parameters, options) ⇒ Object
  • ~postPartnerTokenRequest(parameters, options) ⇒ Object
  • ~postPartnerToken(parameters, options) ⇒ Object
  • ~getPartnerDevices(parameters, options) ⇒ Object
  • ~putPartnerModuleParameters(parameters, options) ⇒ Object
  • ~postUser(parameters, options) ⇒ Object
  • ~postUserSimplified(parameters, options) ⇒ Object
  • ~getUser(parameters, options) ⇒ Object
  • ~putUser(parameters, options) ⇒ Object
  • ~getUserGuests(parameters, options) ⇒ Object
  • ~postUserGuest(parameters, options) ⇒ Object
  • ~putUserGuest(parameters, options) ⇒ Object
  • ~deleteUserGuest(parameters, options) ⇒ Object
  • ~getUserCollaborators(parameters, options) ⇒ Object
  • ~postUserCollaborator(parameters, options) ⇒ Object
  • ~putUserCollaborator(parameters, options) ⇒ Object
  • ~deleteUserCollaborator(parameters, options) ⇒ Object
  • ~getUserAggregations(parameters, options) ⇒ Object
  • ~postUserAggregation(parameters, options) ⇒ Object
  • ~getUserAggregation(parameters, options) ⇒ Object
  • ~putUserAggregation(parameters, options) ⇒ Object
  • ~deleteUserAggregation(parameters, options) ⇒ Object
  • ~getUserDevices(parameters, options) ⇒ Object
  • ~postUserDevice(parameters, options) ⇒ Object
  • ~getUserDevicePositions(parameters, options) ⇒ Object
  • ~getUserDevice(parameters, options) ⇒ Object
  • ~putUserDevice(parameters, options) ⇒ Object
  • ~deleteUserDevice(parameters, options) ⇒ Object
  • ~getUserDeviceModules(parameters, options) ⇒ Object
  • ~putUserDeviceModule(parameters, options) ⇒ Object
  • ~deleteUserDeviceModule(parameters, options) ⇒ Object
  • ~putUserDeviceShares(parameters, options) ⇒ Object
  • ~getUserDeviceStatistics(parameters, options) ⇒ Object
  • ~getUserDeviceRawData(parameters, options) ⇒ Object
  • ~getUserDeviceHourlyData(parameters, options) ⇒ Object
  • ~getUserDeviceDailyData(parameters, options) ⇒ Object
  • ~getUserDeviceContinuousStatistics(parameters, options) ⇒ Object
  • ~getUserDeviceSummary(parameters, options) ⇒ Object
  • ~getUserDeviceForecasts(parameters, options) ⇒ Object
  • ~getUserForecasts(parameters, options) ⇒ Object
  • ~getUserDailyData(parameters, options) ⇒ Object
  • ~getUserHourlyData(parameters, options) ⇒ Object
  • ~getUserPreferences(parameters, options) ⇒ Object
  • ~putUserPreferences(parameters, options) ⇒ Object
  • ~getOrganisationOperations(parameters, options) ⇒ Object
  • ~postOrganisationOperation(parameters, options) ⇒ Object
  • ~getOrganisationOperation(parameters, options) ⇒ Object
  • ~putOrganisationOperation(parameters, options) ⇒ Object
  • ~deleteOrganisationOperation(parameters, options) ⇒ Object
  • ~getUserAlerts(parameters, options) ⇒ Object
  • ~postUserAlert(parameters, options) ⇒ Object
  • ~putUserAlert(parameters, options) ⇒ Object
  • ~deleteUserAlert(parameters, options) ⇒ Object
  • ~postOrganisationDeprecated(parameters, options) ⇒ Object
  • ~postOrganisation(parameters, options) ⇒ Object
  • ~getOrganisation(parameters, options) ⇒ Object
  • ~putOrganisation(parameters, options) ⇒ Object
  • ~postOrganisationMembersMigration(parameters, options) ⇒ Object
  • ~postOrganisationUser(parameters, options) ⇒ Object
  • ~putOrganisationUser(parameters, options) ⇒ Object
  • ~deleteOrganisationUser(parameters, options) ⇒ Object
  • ~postOrganisationPlace(parameters, options) ⇒ Object
  • ~putOrganisationPlace(parameters, options) ⇒ Object
  • ~getWeatherLive(parameters, options) ⇒ Object

API~getPing(parameters, options) ⇒ Object

Checks API's availability.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
options	Object	Options to override Axios request configuration

API~getCrops(parameters, options) ⇒ Object

Get the crops

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
options	Object	Options to override Axios request configuration

API~getModules(parameters, options) ⇒ Object

Get the modules

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
options	Object	Options to override Axios request configuration

API~postSignupCheck(parameters, options) ⇒ Object

Hit the server to check the email can be used to signup.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
[parameters.authorization]	string	Authorization with Bearer mecanism,
parameters.body	object	The email to check
options	Object	Options to override Axios request configuration

API~postLostPassword(parameters, options) ⇒ Object

Request a password change e-mail.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.body	object	The infos to send the mail
options	Object	Options to override Axios request configuration

API~putPassword(parameters, options) ⇒ Object

Change a user password

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.body	object	The infos to change the password
options	Object	Options to override Axios request configuration

API~postLogin(parameters, options) ⇒ Object

Log a user in

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.body	object	The infos to log in
options	Object	Options to override Axios request configuration

API~postVerify(parameters, options) ⇒ Object

Verify a user

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.body	object	Verify the user
options	Object	Options to override Axios request configuration

API~postPartnerTokenRequest(parameters, options) ⇒ Object

Request a user token

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.partnerId	number	The partner organisation id,
parameters.body	object	Request a user token,
parameters.authorization	string	Authorization with Basic mecanism
options	Object	Options to override Axios request configuration

API~postPartnerToken(parameters, options) ⇒ Object

Create a user token

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.partnerId	number	The partner organisation id,
parameters.body	object	Create a user token,
parameters.authorization	string	Authorization with Basic mecanism
options	Object	Options to override Axios request configuration

API~getPartnerDevices(parameters, options) ⇒ Object

Retrieves the devices a partner has access to.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.partnerId	number	The partner organisation id,
parameters.limit	number	The number of items to retrieve,
parameters.start	number	The index in results,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putPartnerModuleParameters(parameters, options) ⇒ Object

Update an partner module parameters

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.partnerId	number	The partner organisation id,
parameters.partnerUserId	number	The partner user id,
parameters.deviceId	number	The device id,
parameters.moduleId	number	The module id,
parameters.body	object	The module parameters,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postUser(parameters, options) ⇒ Object

Create a new user.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.body	object	The new user
options	Object	Options to override Axios request configuration

API~postUserSimplified(parameters, options) ⇒ Object

Create a new user with simplified information (for meeting/showroom/...), add a demo device and connect it. Need a special code.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.body	object	The new user (simplified) and the special code
options	Object	Options to override Axios request configuration

API~getUser(parameters, options) ⇒ Object

Get a user's profile.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUser(parameters, options) ⇒ Object

Update a user's profile.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.body	object	The new user,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserGuests(parameters, options) ⇒ Object

Get a user's guests.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postUserGuest(parameters, options) ⇒ Object

Create a user's guest.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
[parameters.organisationIdTarget]	number	The organisation id to add the collaborator to,
parameters.body	object	The user's guest,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserGuest(parameters, options) ⇒ Object

Update a user's guest.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.guestId	number	The guest id,
parameters.body	object	The user's guest,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteUserGuest(parameters, options) ⇒ Object

Delete a user's guest.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
[parameters.organisationIdTarget]	number	The organisation id to remove the collaborator to,
parameters.guestId	number	The guest id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserCollaborators(parameters, options) ⇒ Object

Get a user's collaborators.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postUserCollaborator(parameters, options) ⇒ Object

Create a user's collaborator.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
[parameters.organisationIdTarget]	number	The organisation id to add the collaborator to,
parameters.body	object	The user's collaborator,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserCollaborator(parameters, options) ⇒ Object

Update a user's collaborator.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.collaboratorId	string	The collaborator id,
parameters.body	object	The user's collaborator,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteUserCollaborator(parameters, options) ⇒ Object

Delete a user's collaborator.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
[parameters.organisationIdTarget]	number	The organisation id to remove the collaborator to,
parameters.collaboratorId	number	The collaborator id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserAggregations(parameters, options) ⇒ Object

Get a user's aggregations.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
[parameters.compute]	boolean	Wether the aggregations should be computed,
[parameters.patched]	boolean	Wether you want to get only original data or eventually patched ones to avoid holes.,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postUserAggregation(parameters, options) ⇒ Object

Create a user's aggregation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.body	object	The user's aggregation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserAggregation(parameters, options) ⇒ Object

Get a single user aggregation with statistics for graphs

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.aggregationId	number	The aggregation id,
[parameters.patched]	boolean	Wether you want to get only original data or eventually patched ones to avoid holes.,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserAggregation(parameters, options) ⇒ Object

Update a user's aggregation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.aggregationId	number	The aggregation id,
parameters.body	object	The user's aggregation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteUserAggregation(parameters, options) ⇒ Object

Delete a user's aggregation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.aggregationId	number	The aggregation id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDevices(parameters, options) ⇒ Object

Get a user's devices.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
[parameters.date]	string	The status date,
[parameters.measures]	array	The measures to read,
[parameters.patched]	boolean	Wether you want to get only original data or eventually patched ones to avoid holes.,
[parameters.limit]	number	The number of items to retrieve,
[parameters.start]	number	The index in results,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postUserDevice(parameters, options) ⇒ Object

Setup a user's device.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.body	object	The user device activation couple,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDevicePositions(parameters, options) ⇒ Object

Get a user's device geographic positions historic.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDevice(parameters, options) ⇒ Object

Get a user's device.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserDevice(parameters, options) ⇒ Object

Update a user's device.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.body	object	The user device,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteUserDevice(parameters, options) ⇒ Object

Delete a user's device access.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceModules(parameters, options) ⇒ Object

Get the modules a user activated on its device

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserDeviceModule(parameters, options) ⇒ Object

Add a module to a user's device

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.moduleId	number	The module id,
parameters.body	object	The module settings,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteUserDeviceModule(parameters, options) ⇒ Object

Disable a module for a user's device

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.moduleId	number	The module id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserDeviceShares(parameters, options) ⇒ Object

Update a user's device shares.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.sharesType	string	The shares type,
parameters.body	array	The users concerned by the user's device share,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceStatistics(parameters, options) ⇒ Object

Get a user's device's device's statistics.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.startDate	string	The statistics start date,
parameters.endDate	string	The statistics end date,
parameters.measures	array	The measures to read,
[parameters.patched]	boolean	Wether you want to get only original data or eventually patched ones to avoid holes.,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceRawData(parameters, options) ⇒ Object

Get a user's device's raw data.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.beforeDate	string	The date before which the data starts being retrieved,
parameters.size	number	The number of measures to retrieve,
parameters.measures	array	The measures to read,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceHourlyData(parameters, options) ⇒ Object

Get a user's device's hourly data.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.beforeDate	string	The date before which the data starts being retrieved,
parameters.days	number	The number of days to retrieve,
parameters.measures	array	The measures to read,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceDailyData(parameters, options) ⇒ Object

Get a user's device's daily data.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.beforeDate	string	The date before which the data starts being retrieved,
parameters.days	number	The number of days to retrieve,
parameters.measures	array	The measures to read,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceContinuousStatistics(parameters, options) ⇒ Object

Get a user's device's continuous device's statistics.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.startDate	string	The statistics start date,
parameters.endDate	string	The statistics end date,
parameters.measures	array	The measures to read,
[parameters.patched]	boolean	Wether you want to get only original data or eventually patched ones to avoid holes.,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceSummary(parameters, options) ⇒ Object

Get a user's device's summary at a given date.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.date	string	The summary date,
parameters.measures	array	The measures to read,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDeviceForecasts(parameters, options) ⇒ Object

Get a user's device's forecasts.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
parameters.date	string	Date of the forecasts,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserForecasts(parameters, options) ⇒ Object

Get a user's forecasts.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.latitude	number	The latitude of the data,
parameters.longitude	number	The longitude of the data,
[parameters.date]	string	Date of the forecasts,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserDailyData(parameters, options) ⇒ Object

Get a user's daily data for a given geo location.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.latitude	number	The latitude of the data,
parameters.longitude	number	The longitude of the data,
parameters.beforeDate	string	The date before which the data starts being retrieved,
parameters.days	number	The number of days to retrieve,
parameters.measures	array	The measures to read,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserHourlyData(parameters, options) ⇒ Object

Get a user's hourly data for a given geo location.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.latitude	number	The latitude of the data,
parameters.longitude	number	The longitude of the data,
parameters.beforeDate	string	The date before which the data starts being retrieved,
parameters.days	number	The number of days to retrieve,
parameters.measures	array	The measures to read,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserPreferences(parameters, options) ⇒ Object

Get a user's preferences.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserPreferences(parameters, options) ⇒ Object

Update a user's preferences.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.body	object	The new user preferences,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getOrganisationOperations(parameters, options) ⇒ Object

Get a organisation's operations.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postOrganisationOperation(parameters, options) ⇒ Object

Create an organisation's operation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.body	object	The operation to add,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getOrganisationOperation(parameters, options) ⇒ Object

Retrieve an organisation's operation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.operationId	number	The operation id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putOrganisationOperation(parameters, options) ⇒ Object

Update an organisation's operation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.operationId	number	The operation id,
parameters.body	object	The operation to update,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteOrganisationOperation(parameters, options) ⇒ Object

Delete an organisation's operation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.operationId	number	The operation id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getUserAlerts(parameters, options) ⇒ Object

Get a user's alerts.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postUserAlert(parameters, options) ⇒ Object

Create a user's alert.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.body	object	The user's alert,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putUserAlert(parameters, options) ⇒ Object

Update a user's alert.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.alertId	number	The alert id,
parameters.body	object	The user's alert,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteUserAlert(parameters, options) ⇒ Object

Delete a user's alert.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.alertId	number	The alert id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postOrganisationDeprecated(parameters, options) ⇒ Object

Creates a new organisation. Highly Deprecated, will be moved soon.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.body	object	The necessary contents to create a new organisation
options	Object	Options to override Axios request configuration

API~postOrganisation(parameters, options) ⇒ Object

Creates a new organisation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.userId	number	The user id,
parameters.body	object	The necessary contents to create a new organisation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getOrganisation(parameters, options) ⇒ Object

Get the organisation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putOrganisation(parameters, options) ⇒ Object

Update an organisation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.body	object	The modified organisation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postOrganisationMembersMigration(parameters, options) ⇒ Object

Endpoint for migration. Don't use it or use with caution !

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.body	object	The necessary contents to migrate users,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postOrganisationUser(parameters, options) ⇒ Object

Add an user to an organisation

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.targetUserId	number	The user id to add,
parameters.body	object	The type of relation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putOrganisationUser(parameters, options) ⇒ Object

Edit or add an user to an organisation

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.targetUserId	number	The user id to add,
parameters.body	object	The type of relation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~deleteOrganisationUser(parameters, options) ⇒ Object

Delete an user from an organisation

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.targetUserId	number	The user id to remove,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~postOrganisationPlace(parameters, options) ⇒ Object

Create a new place for an organisation.

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.body	object	The necessary contents to create a new place for an organisation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~putOrganisationPlace(parameters, options) ⇒ Object

Update a place for an organisation

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.organisationId	number	The organisation id,
parameters.placeId	number	The place id,
parameters.body	object	The necessary contents to update a place for an organisation,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

API~getWeatherLive(parameters, options) ⇒ Object

Get last measure (for a specific type) from devices in a given area (1hour for RAIN_TIC).

Kind: inner method of API
Returns: Object - The HTTP response

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.geohash	string	The geohash of the data,
parameters.measureType	string	The measures to read,
parameters.authorization	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Access token in the query string
options	Object	Options to override Axios request configuration

License

MIT

Changelog

1.13.0 (2018-09-28)

<a name="1.12.0"></a>