API

API

API to consume Sencrop data

Version: 1.60.11

• API
  • ~deleteOrganisationChargebeeId(parameters, options) ⇒ Object
  • ~postOrganisationChargebeeId(parameters, body, options) ⇒ Object
  • ~deleteOrganisationDevice(parameters, options) ⇒ Object
  • ~getOrganisationDevice(parameters, options) ⇒ Object
  • ~putOrganisationDevice(parameters, body, options) ⇒ Object
  • ~deleteOrganisationNetworkDeviceAccess(parameters, options) ⇒ Object
  • ~putOrganisationNetworkDeviceAccess(parameters, options) ⇒ Object
  • ~deleteUserOrganisationAggregation(parameters, options) ⇒ Object
  • ~putUserOrganisationAggregation(parameters, body, options) ⇒ Object
  • ~deleteUserOrganisationAlert(parameters, options) ⇒ Object
  • ~putUserOrganisationAlert(parameters, body, options) ⇒ Object
  • ~deleteUserOrganisationDeviceModule(parameters, options) ⇒ Object
  • ~putUserOrganisationDeviceModule(parameters, body, options) ⇒ Object
  • ~deleteUserOrganisationInvitation(parameters, options) ⇒ Object
  • ~putUserOrganisationInvitation(parameters, body, options) ⇒ Object
  • ~deleteUserOrganisationMember(parameters, options) ⇒ Object
  • ~putUserOrganisationMember(parameters, body, options) ⇒ Object
  • ~putUserOrganisationOpenNetworkMembership(parameters, options) ⇒ Object
  • ~deleteUserOrganisationShare(parameters, options) ⇒ Object
  • ~putUserOrganisationShare(parameters, body, options) ⇒ Object
  • ~getOpenAPI(parameters, options) ⇒ Object
  • ~getCrops(parameters, options) ⇒ Object
  • ~getFactorySigfoxStatus(parameters, options) ⇒ Object
  • ~getInvitation(parameters, options) ⇒ Object
  • ~getInvitationDeviceLiveAggregations(parameters, options) ⇒ Object
  • ~getModules(parameters, options) ⇒ Object
  • ~getMySelf(parameters, options) ⇒ Object
  • ~getNetwork(parameters, options) ⇒ Object
  • ~getNetworkDeviceLiveAggregations(parameters, options) ⇒ Object
  • ~getNetworkDevices(parameters, options) ⇒ Object
  • ~getOAuth2Authorize(parameters, options) ⇒ Object
  • ~getOrganisation(parameters, options) ⇒ Object
  • ~putOrganisation(parameters, body, options) ⇒ Object
  • ~getOrganisationChargebeePortalSession(parameters, options) ⇒ Object
  • ~getOrganisationDevices(parameters, options) ⇒ Object
  • ~getOrganisationDevicesLiveAggregations(parameters, options) ⇒ Object
  • ~getOrganisationHostedPage(parameters, options) ⇒ Object
  • ~getOrganisationInvitation(parameters, options) ⇒ Object
  • ~getOrganisationInvitations(parameters, options) ⇒ Object
  • ~getOrganisationMember(parameters, options) ⇒ Object
  • ~getOrganisationMembers(parameters, options) ⇒ Object
  • ~getOrganisationNetworkDevices(parameters, options) ⇒ Object
  • ~getOrganisationNetworks(parameters, options) ⇒ Object
  • ~getOrganisationPlace(parameters, options) ⇒ Object
  • ~getOrganisationPlaces(parameters, options) ⇒ Object
  • ~postOrganisationPlace(parameters, body, options) ⇒ Object
  • ~getOrganisationPreferences(parameters, options) ⇒ Object
  • ~putOrganisationPreferences(parameters, body, options) ⇒ Object
  • ~getOrganisationShare(parameters, options) ⇒ Object
  • ~getOrganisationShares(parameters, options) ⇒ Object
  • ~getOrganisationsTrialOperations(parameters, options) ⇒ Object
  • ~getPartnerDevices(parameters, options) ⇒ Object
  • ~getPing(parameters, options) ⇒ Object
  • ~getPublicWeatherLive(parameters, options) ⇒ Object
  • ~getPublicWeatherLiveAggregations(parameters, options) ⇒ Object
  • ~getQuote(parameters, options) ⇒ Object
  • ~getQuoteHostedPage(parameters, options) ⇒ Object
  • ~getSearchDevices(parameters, options) ⇒ Object
  • ~getSearchNetworkDevices(parameters, options) ⇒ Object
  • ~getSearchUser(parameters, options) ⇒ Object
  • ~getTrialOperation(parameters, options) ⇒ Object
  • ~getUser(parameters, options) ⇒ Object
  • ~putUser(parameters, body, options) ⇒ Object
  • ~getUserAggregation(parameters, options) ⇒ Object
  • ~getUserAggregations(parameters, options) ⇒ Object
  • ~getUserAlerts(parameters, options) ⇒ Object
  • ~getUserDailyData(parameters, options) ⇒ Object
  • ~getUserDevice(parameters, options) ⇒ Object
  • ~getUserDeviceContinuousStatistics(parameters, options) ⇒ Object
  • ~getUserDeviceDailyData(parameters, options) ⇒ Object
  • ~getUserDeviceForecasts(parameters, options) ⇒ Object
  • ~getUserDeviceHourlyData(parameters, options) ⇒ Object
  • ~getUserDeviceModules(parameters, options) ⇒ Object
  • ~getUserDevicePositions(parameters, options) ⇒ Object
  • ~getUserDeviceRawData(parameters, options) ⇒ Object
  • ~getUserDeviceStatistics(parameters, options) ⇒ Object
  • ~getUserDeviceSummary(parameters, options) ⇒ Object
  • ~getUserDevices(parameters, options) ⇒ Object
  • ~getUserDevicesLiveAggregations(parameters, options) ⇒ Object
  • ~getUserForecasts(parameters, options) ⇒ Object
  • ~getUserHourlyData(parameters, options) ⇒ Object
  • ~getUserIntercomHash(parameters, options) ⇒ Object
  • ~getUserInvitation(parameters, options) ⇒ Object
  • ~getUserInvitations(parameters, options) ⇒ Object
  • ~getUserOrganisations(parameters, options) ⇒ Object
  • ~postUserOrganisation(parameters, body, options) ⇒ Object
  • ~getUserPendingInvitation(parameters, options) ⇒ Object
  • ~getUserPendingInvitations(parameters, options) ⇒ Object
  • ~getUserPreferences(parameters, options) ⇒ Object
  • ~putUserPreferences(parameters, body, options) ⇒ Object
  • ~getUserStatistics(parameters, options) ⇒ Object
  • ~getWeatherLive(parameters, options) ⇒ Object
  • ~postInvitationResend(parameters, options) ⇒ Object
  • ~postLogin(parameters, body, options) ⇒ Object
  • ~postLostPassword(parameters, body, options) ⇒ Object
  • ~postOAuth2Token(parameters, body, options) ⇒ Object
  • ~postOrganisation(parameters, body, options) ⇒ Object
  • ~postOrganisationEndTrialSupport(parameters, options) ⇒ Object
  • ~postOrganisationNetworkMemberPlan(parameters, body, options) ⇒ Object
  • ~postOrganisationPaymentComplete(parameters, body, options) ⇒ Object
  • ~postOrganisationToNetworkSupport(parameters, body, options) ⇒ Object
  • ~postOrganisationTrialReactivation(parameters, options) ⇒ Object
  • ~postPartnerToken(parameters, body, options) ⇒ Object
  • ~postPartnerTokenRequest(parameters, body, options) ⇒ Object
  • ~postQuoteOffline(parameters, options) ⇒ Object
  • ~postRegister(parameters, body, options) ⇒ Object
  • ~postSignatureCloudinary(parameters, body, options) ⇒ Object
  • ~postSignupCheck(parameters, body, options) ⇒ Object
  • ~postSocialImage(parameters, body, options) ⇒ Object
  • ~postUser(parameters, body, options) ⇒ Object
  • ~postUserDeviceExport(parameters, body, options) ⇒ Object
  • ~postUserNetworkInvitation(parameters, body, options) ⇒ Object
  • ~postUserOrganisationAggregation(parameters, body, options) ⇒ Object
  • ~postUserOrganisationAlert(parameters, body, options) ⇒ Object
  • ~postUserOrganisationDevice(parameters, body, options) ⇒ Object
  • ~postUserOrganisationInvitation(parameters, body, options) ⇒ Object
  • ~postUserOrganisationMember(parameters, body, options) ⇒ Object
  • ~postUserPassword(parameters, body, options) ⇒ Object
  • ~postVerify(parameters, body, options) ⇒ Object
  • ~putOrganisationDeviceCalibration(parameters, options) ⇒ Object
  • ~putOrganisationDeviceSettings(parameters, body, options) ⇒ Object
  • ~putOrganisationPlace(parameters, body, options) ⇒ Object
  • ~putOrganisationTrial(parameters, body, options) ⇒ Object
  • ~putPartnerModuleParameters(parameters, body, options) ⇒ Object
  • ~putPassword(parameters, body, options) ⇒ Object
  • ~putUserFCMToken(parameters, body, options) ⇒ Object
  • ~putUserInvitationAnswer(parameters, body, options) ⇒ Object
  • ~getGraphQL(parameters, options) ⇒ Object
  • ~postGraphQL(parameters, body, options) ⇒ Object

API~deleteOrganisationChargebeeId(parameters, options) ⇒ Object

Remove chargebeeId from 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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postOrganisationChargebeeId(parameters, body, options) ⇒ Object

Add chargebeeId for an organisation.

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

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

API~deleteOrganisationDevice(parameters, options) ⇒ Object

Delete an organisation's device access.

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.deviceId	number	The device id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationDevice(parameters, options) ⇒ Object

Get a current organisation's device.

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.deviceId	number	The device id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putOrganisationDevice(parameters, body, options) ⇒ Object

Update an organisation's device.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.organisationId	number	The organisation id,
parameters.deviceId	number	The device id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~deleteOrganisationNetworkDeviceAccess(parameters, options) ⇒ Object

Delete an organisation's network device access.

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.networkId	string	The network id,
parameters.deviceId	number	The device id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putOrganisationNetworkDeviceAccess(parameters, options) ⇒ Object

Update an organisation's device.

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.networkId	string	The network id,
parameters.deviceId	number	The device id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~deleteUserOrganisationAggregation(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.organisationId	number	The organisation id,
parameters.aggregationId	string	The aggregation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserOrganisationAggregation(parameters, body, options) ⇒ Object

Upsert an organisation's aggregation.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
parameters.aggregationId	string	The aggregation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~deleteUserOrganisationAlert(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.organisationId	number	The organisation id,
parameters.alertId	string	The alert id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserOrganisationAlert(parameters, body, options) ⇒ Object

Update an organisation's alert.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
parameters.alertId	string	The alert id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~deleteUserOrganisationDeviceModule(parameters, options) ⇒ Object

Disable a module for a user's organisations'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.organisationId	number	The organisation id,
parameters.deviceId	number	The device id,
parameters.moduleId	number	The module id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserOrganisationDeviceModule(parameters, body, options) ⇒ Object

Add a module to a user's organisations's device

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
parameters.deviceId	number	The device id,
parameters.moduleId	number	The module id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~deleteUserOrganisationInvitation(parameters, options) ⇒ Object

Delete a user's organisation invitation.

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.organisationId	number	The organisation id,
parameters.invitationId	string	The invitation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserOrganisationInvitation(parameters, body, options) ⇒ Object

Update an organisation's invitation.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
parameters.invitationId	string	The invitation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~deleteUserOrganisationMember(parameters, options) ⇒ Object

Delete a member from an user's 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.organisationId	number	The organisation id,
parameters.memberId	number	The member id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserOrganisationMember(parameters, body, options) ⇒ Object

Add or edit an member to an organisation

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
parameters.memberId	number	The member id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserOrganisationOpenNetworkMembership(parameters, options) ⇒ Object

Allow an organisation to join an open network

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.organisationId	number	The organisation id,
parameters.networkId	string	The network id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~deleteUserOrganisationShare(parameters, options) ⇒ Object

undefined

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.organisationId	number	The organisation id,
parameters.shareId	string	The share id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserOrganisationShare(parameters, body, options) ⇒ Object

undefined

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
parameters.shareId	string	The share id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOpenAPI(parameters, options) ⇒ Object

Get API documentation.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
[parameters.mutedParameters]	array	undefined,
[parameters.mutedMethods]	array	undefined,
[parameters.tags]	array	undefined,
[parameters.authenticated]	boolean	undefined,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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~getFactorySigfoxStatus(parameters, options) ⇒ Object

Get sigfox statuses for devices in production line tests

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.serial	string	Sigfox serial from a device,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getInvitation(parameters, options) ⇒ Object

Get an invitation.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.invitationId	string	The invitation id
options	Object	Options to override Axios request configuration

API~getInvitationDeviceLiveAggregations(parameters, options) ⇒ Object

Retrieve last measures for a given device from an invitation

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.invitationId	string	The invitation id,
parameters.deviceId	number	The device id,
parameters.timeZone	string	The timezone of the data
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~getMySelf(parameters, options) ⇒ Object

Redirect to the user profile.

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.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getNetwork(parameters, options) ⇒ Object

Get the network.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.networkId	string	The network id
options	Object	Options to override Axios request configuration

API~getNetworkDeviceLiveAggregations(parameters, options) ⇒ Object

Retrieve last measures for a given device from a network

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.networkId	string	The network id,
parameters.deviceId	number	The device id,
parameters.timeZone	string	The timezone of the data
options	Object	Options to override Axios request configuration

API~getNetworkDevices(parameters, options) ⇒ Object

Get devices for a network

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.networkId	string	The network id
options	Object	Options to override Axios request configuration

API~getOAuth2Authorize(parameters, options) ⇒ Object

Implements the Authorization Endpoint as defined per the OAuth2 RFC.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.responseType	string	undefined,
parameters.clientId	string	undefined,
[parameters.redirectUri]	string	undefined,
[parameters.scope]	string	See https://tools.ietf.org/html/rfc6749#section-3.3,
parameters.state	string	undefined
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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putOrganisation(parameters, body, 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)
body		The request body
parameters.organisationId	number	The organisation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationChargebeePortalSession(parameters, options) ⇒ Object

Create a chargebee portal session

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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationDevices(parameters, options) ⇒ Object

Get a current organisation's devices.

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.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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationDevicesLiveAggregations(parameters, options) ⇒ Object

Allow to run live aggregation queries against an organisation's devices.

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.devicesIds	array	List of id's of devices,
parameters.aggregations	array	The aggregations names,
[parameters.parameters]	array	The params to set,
parameters.intervals	array	The intervals to retrieve,
[parameters.timeZone]	string	The timezone of the data,
[parameters.date]	string	The status date,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationHostedPage(parameters, options) ⇒ Object

Create a chargebee hosted page 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.redirectUrl]	string	Specifies the callback url for chargebee hosted page,
parameters.planId	string	Plan id related to chargebee plans,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationInvitation(parameters, options) ⇒ Object

Get a user's invitation.

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.invitationId	string	The invitation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationInvitations(parameters, options) ⇒ Object

Get an organisation's invitations.

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.limit	number	The number of items to retrieve,
parameters.start	number	The index in results,
[parameters.withTypes]	array	undefined,
[parameters.withStatuses]	array	undefined,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationMember(parameters, options) ⇒ Object

Retrieve all members 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.memberId	number	The member id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationMembers(parameters, options) ⇒ Object

Retrieve all members 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.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationNetworkDevices(parameters, options) ⇒ Object

Get an organisation network.

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.networkId	string	The network id,
parameters.limit	number	The number of items to retrieve,
parameters.start	number	The index in results,
[parameters.geohash]	string	The geohash to lookup,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationNetworks(parameters, options) ⇒ Object

Get the networks an organisation has access to.

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.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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationPlace(parameters, options) ⇒ Object

Get a specific place for a 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.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationPlaces(parameters, options) ⇒ Object

Get all places 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.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postOrganisationPlace(parameters, body, 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)
body		The request body
parameters.organisationId	number	The organisation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationPreferences(parameters, options) ⇒ Object

Get an organisation's preferences.

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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putOrganisationPreferences(parameters, body, options) ⇒ Object

Update a organisation's preferences.

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

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

API~getOrganisationShare(parameters, options) ⇒ Object

Get an organisation's shares.

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.shareId	string	The share id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationShares(parameters, options) ⇒ Object

Get an organisation's shares.

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.limit	number	The number of items to retrieve,
parameters.start	number	The index in results,
[parameters.withTypes]	array	undefined,
[parameters.isTransmittable]	boolean	undefined,
[parameters.withModes]	array	undefined,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getOrganisationsTrialOperations(parameters, options) ⇒ Object

Get an organisation's trial 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.active]	boolean	If true, returns only active trial operations (not ended and not expired),
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	Token provided through query parameters
options	Object	Options to override Axios request configuration

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~getPublicWeatherLive(parameters, options) ⇒ Object

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

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.topLeftBoxX	number	X coordinate of the top left corner of the map,
parameters.topLeftBoxY	number	Y coordinate of the top left corner of the map,
parameters.bottomRightBoxX	number	X coordinate of the bottom right corner of the map,
parameters.bottomRightBoxY	number	Y coordinate of the bottom right corner of the map,
parameters.measureType	string	The type of measure to retrieve,
parameters.aggregationType	string	The type of aggregation,
parameters.precision	number	The precision of the map,
[parameters.timeFrame]	string	The aggregatable measure,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getPublicWeatherLiveAggregations(parameters, options) ⇒ Object

Get last measure (for a specifics measures and interval) from devices in a given area

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 to lookup,
parameters.aggregations	array	The aggregations names,
parameters.liveInterval	string	The interval to retrieve,
[parameters.timeZone]	string	The timezone of the data,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getQuote(parameters, options) ⇒ Object

Get a quote

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.quoteId	string	The quote id
options	Object	Options to override Axios request configuration

API~getQuoteHostedPage(parameters, options) ⇒ Object

Create a chargebee hosted page for quote

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.quoteId	string	The quote id,
[parameters.tva]	string	undefined,
[parameters.paymentMethod]	string	undefined,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getSearchDevices(parameters, options) ⇒ Object

Search devices around a geopoint

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.latitude	number	The latitude of the data,
parameters.longitude	number	The longitude of the data
options	Object	Options to override Axios request configuration

API~getSearchNetworkDevices(parameters, options) ⇒ Object

Search devices around a geopoint for a network

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.latitude	number	The latitude of the data,
parameters.longitude	number	The longitude of the data,
parameters.networkId	string	The network id
options	Object	Options to override Axios request configuration

API~getSearchUser(parameters, options) ⇒ Object

Search for an user

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.email	string	Email of the user to search,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getTrialOperation(parameters, options) ⇒ Object

Get a trial operation

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.trialOperationId	string	The trial operation id
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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUser(parameters, body, 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)
body		The request body
parameters.userId	number	The user id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	string	The aggregation id,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
[parameters.ranges]	array	The ranges to get the data from,
parameters.measures	array	The measures to read,
[parameters.withCalibration]	boolean	Wether the calibration of rain falls must be taken in count,
[parameters.timeZone]	string	The timezone of the data,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.includeHistory]	boolean	If must include device replacements or not,
[parameters.timeZone]	string	The timezone of the data,
[parameters.interval]	string	The interval of data (Accepted value : 31 days for 1h interval, 1 year for 1d interval, 5y for 1w interval),
[parameters.withCalibration]	boolean	Wether the calibration of rain falls must be taken in count,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
[parameters.timeZone]	string	The timezone of the data,
parameters.measures	array	The measures to read,
[parameters.withCalibration]	boolean	Wether the calibration of rain falls must be taken in count,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
[parameters.timeZone]	string	The timezone of the data,
parameters.days	number	The number of days to retrieve,
parameters.measures	array	The measures to read,
[parameters.withCalibration]	boolean	Wether the calibration of rain falls must be taken in count,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
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	Token provided through query parameters
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	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.includeHistory]	boolean	If must include device replacements or not,
[parameters.timeZone]	string	The timezone of the data,
[parameters.interval]	string	The interval of data (Accepted value : 31 days for 1h interval, 1 year for 1d interval, 5y for 1w interval),
[parameters.withCalibration]	boolean	Wether the calibration of rain falls must be taken in count,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
parameters.date	string	The summary date,
parameters.measures	array	The measures to read,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
[parameters.date]	string	The status date,
[parameters.measures]	array	The measures to read,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserDevicesLiveAggregations(parameters, options) ⇒ Object

Allow to run live aggregation queries against a user 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.devicesIds	array	List of id's of devices,
parameters.aggregations	array	The aggregations names,
[parameters.parameters]	array	The params to set,
parameters.intervals	array	The intervals to retrieve,
[parameters.timeZone]	string	The timezone of the data,
[parameters.date]	string	The status date,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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	Token provided through query parameters
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.includeHistory]	boolean	If must include device replacements or not,
parameters.days	number	The number of days to retrieve,
[parameters.ranges]	array	The ranges to get the data from,
parameters.measures	array	The measures to read,
[parameters.withCalibration]	boolean	Wether the calibration of rain falls must be taken in count,
[parameters.timeZone]	string	The timezone of the data,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserIntercomHash(parameters, options) ⇒ Object

HMAC Digest for the userId, used for the identity verification of intercom

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.platform	string	Type of the platform,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserInvitation(parameters, options) ⇒ Object

Get a user's invitation.

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.invitationId	string	The invitation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserInvitations(parameters, options) ⇒ Object

Get a user's invitations.

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.limit	number	The number of items to retrieve,
parameters.start	number	The index in results,
[parameters.withTypes]	array	undefined,
[parameters.withStatuses]	array	undefined,
[parameters.withModes]	array	undefined,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserOrganisations(parameters, options) ⇒ Object

Get all user's organisations.

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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUserOrganisation(parameters, body, options) ⇒ Object

Creates a new organisation for a user (add him as owner).

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

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

API~getUserPendingInvitation(parameters, options) ⇒ Object

Get a user's pending invitation.

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.invitationId	string	The invitation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserPendingInvitations(parameters, options) ⇒ Object

Get a user's pending invitations.

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.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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserPreferences(parameters, options) ⇒ Object

Get an 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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putUserPreferences(parameters, body, 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)
body		The request body
parameters.userId	number	The user id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getUserStatistics(parameters, options) ⇒ Object

Get a user's statistics for a given 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.startDate	string	The statistics start date,
parameters.endDate	string	The statistics end date,
parameters.measures	array	The measures to read,
parameters.ranges	array	The ranges to get the data from,
[parameters.patched]	boolean	Patched data are augmented data with internal algorithms. Setting patched to false, will return raw data from device only.,
[parameters.includeHistory]	boolean	If must include device replacements or not,
[parameters.interval]	string	The interval of data (Accepted value : 31 days for 1h interval, 1 year for 1d interval, 5y for 1w interval),
[parameters.withCalibration]	boolean	Wether the calibration of rain falls must be taken in count,
[parameters.timeZone]	string	The timezone of the data,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
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 (1 hour for RAIN_FALL).

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 to lookup,
parameters.measureType	string	The measures to read,
[parameters.timeFrame]	string	The aggregatable measure,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postInvitationResend(parameters, options) ⇒ Object

Resend the invitation

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.invitationId	string	The invitation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postLogin(parameters, body, 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)
body		The request body
options	Object	Options to override Axios request configuration

API~postLostPassword(parameters, body, 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)
body		The request body
options	Object	Options to override Axios request configuration

API~postOAuth2Token(parameters, body, options) ⇒ Object

Implements the Token Endpoint as defined per the OAuth2 RFC.

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

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

API~postOrganisation(parameters, body, 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)
body		The request body
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postOrganisationEndTrialSupport(parameters, options) ⇒ Object

Remove the trial of 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.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postOrganisationNetworkMemberPlan(parameters, body, options) ⇒ Object

Add a plan to a organisation of a sponsored network

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.organisationId	number	The organisation id,
parameters.networkMemberId	number	The organisation id of the network member,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postOrganisationPaymentComplete(parameters, body, options) ⇒ Object

Complete the payment flow of an organisation, if chargebee hook is delayed

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

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

API~postOrganisationToNetworkSupport(parameters, body, options) ⇒ Object

Convert an organisation to a network

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

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

API~postOrganisationTrialReactivation(parameters, options) ⇒ Object

Reactivate a trial 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	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postPartnerToken(parameters, body, options) ⇒ Object

Create a user token (deprecated, use OAuth2)

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

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

API~postPartnerTokenRequest(parameters, body, 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)
body		The request body
parameters.partnerId	number	The partner organisation id,
[parameters.authorization]	string	Authorization with Basic mecanism
options	Object	Options to override Axios request configuration

API~postQuoteOffline(parameters, options) ⇒ Object

Set offline mode for a quote

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.quoteId	string	The quote id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postRegister(parameters, body, options) ⇒ Object

Register a new user and his organisation

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
[parameters.noTrial]	boolean	Deprecated, not used anymore,
[parameters.trialOperationId]	string	Operation trial id used to compute trialEndDate of organisation,
[parameters.referralId]	string	UUID of the godfather organisation (through a referral program),
[parameters.referralAuthorId]	string	ID of the godfather user (through a referral program),
[parameters.marketingOptin]	boolean	ID of the godfather user (through a referral program)
options	Object	Options to override Axios request configuration

API~postSignatureCloudinary(parameters, body, options) ⇒ Object

Get a cloudinary signature to make a signed upload

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postSignupCheck(parameters, body, 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)
body		The request body
[parameters.authorization]	string	Authorization with Bearer mechanism
options	Object	Options to override Axios request configuration

API~postSocialImage(parameters, body, options) ⇒ Object

Generate a new image to share it on social media

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUser(parameters, body, 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)
body		The request body
options	Object	Options to override Axios request configuration

API~postUserDeviceExport(parameters, body, options) ⇒ Object

Create a new export job

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.deviceId	number	The device id,
[parameters.emailRecipient]	string	Recipient email of the export (override default user email),
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUserNetworkInvitation(parameters, body, options) ⇒ Object

Invite a user to reach the Network page

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.networkId	string	The network id,
[parameters.trialOperationId]	string	Operation trial id used to compute trialEndDate of organisation
options	Object	Options to override Axios request configuration

API~postUserOrganisationAggregation(parameters, body, options) ⇒ Object

Create a new organisation's aggregation.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUserOrganisationAlert(parameters, body, options) ⇒ Object

Create a new organisation's alert.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUserOrganisationDevice(parameters, body, options) ⇒ Object

Setup a organisation's device.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.organisationId	number	The organisation id,
parameters.userId	number	The user id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUserOrganisationInvitation(parameters, body, options) ⇒ Object

Create an organisation's invitation.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUserOrganisationMember(parameters, body, options) ⇒ Object

Add an member to an organisation

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.organisationId	number	The organisation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postUserPassword(parameters, body, options) ⇒ Object

Update user password

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

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

API~postVerify(parameters, body, 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)
body		The request body
options	Object	Options to override Axios request configuration

API~putOrganisationDeviceCalibration(parameters, options) ⇒ Object

Update an organisation's device calibration.

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.deviceId	number	The device id,
parameters.calibrationName	string	Calibration to set,
parameters.ratio	number	Ratio to set,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putOrganisationDeviceSettings(parameters, body, options) ⇒ Object

Update an organisation's device's settings.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.organisationId	number	The organisation id,
parameters.deviceId	number	The device id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putOrganisationPlace(parameters, body, 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)
body		The request body
parameters.organisationId	number	The organisation id,
parameters.placeId	number	The place id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putOrganisationTrial(parameters, body, options) ⇒ Object

Change trial for an organisation

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.organisationId	number	The organisation id,
[parameters.sendEmail]	boolean	If a trial reactivation should send an email,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putPartnerModuleParameters(parameters, body, 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)
body		The request body
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.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~putPassword(parameters, body, 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)
body		The request body
options	Object	Options to override Axios request configuration

API~putUserFCMToken(parameters, body, options) ⇒ Object

Update Firebase Cloud Messaging token for an user

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

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

API~putUserInvitationAnswer(parameters, body, options) ⇒ Object

Set a user's invitation answer.

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
parameters.userId	number	The user id,
parameters.invitationId	string	The invitation id,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~getGraphQL(parameters, options) ⇒ Object

Graphql endpoint

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
parameters.query	string	The GraphQL query,
[parameters.variables]	string	The GraphQL variables,
[parameters.operationName]	string	The GraphQL operation name,
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration

API~postGraphQL(parameters, body, options) ⇒ Object

Graphql endpoint

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

Param	Type	Description
parameters	Object	The parameters to provide (destructured)
body		The request body
[parameters.authorization]	string	Authorization with Bearer mecanism,
[parameters.accessToken]	string	Token provided through query parameters
options	Object	Options to override Axios request configuration