Cloud Code Exposed APIs

/** @type {string} */
var name = 'KPI_NAME';
/** @type {any} */
var value = 'KPI_VALUE';
/** @type {string[]} - Tags should be an array of Strings, containing only alphanumeric characters and "-" or "\_" */
var tags = [];

analytics.kpis.create(name, value, tags);

/** @type {string|number|boolean|object} */
var infoMsg = 'INFORMATIVE_MESSAGE_TEXT';

// Print informative message
console.log(infoMsg);

// Print informative message (recommendation)
console.log('ID_TEXT', infoMsg);

/** @type {string|number|boolean|object} */
var errorMsg = 'ERROR_MESSAGE_TEXT';

// Print error message
console.error(errorMsg);

// Print error message (recommendation)
console.error('ID_TEXT', errorMsg);

/**
 * @typedef             EmailSendGridCredentials
 * @prop {'SendGrid'}   service         - Service provider name
 * @prop {Object}       auth            - Authentication data provided by the provider
 * @prop {string}       auth.api_user   - API User
 * @prop {string}       auth.api_key    - API Key
 */

/** @type {EmailSendGridCredentials} */
var emailCredentials = {
    service: 'SendGrid',
    auth: {
        api_user: 'YOUR_API_USER',
        api_key: 'YOUR_API_KEY'
    }
};

/**
 * @typedef             EmailOptions
 * @prop {string}       from            - Sender's email
 * @prop {string}       to              - Recipient email
 * @prop {string}       subject         - Mail subject
 * @prop {string}       [text]          - Email content (use when the message is plain text only)
 * @prop {string}       [html]          - Email content (use when message contains HTML)
 */

/** @type {EmailOptions} */
var emailOptions = {
    from: 'SENDER_EMAIL',
    to: 'RECEIVER_EMAIL',
    subject: 'EMAIL_SUBJECT_TEXT',
    text: 'EMAIL_CONTENT_TEXT'
};

// Send mail
email(emailCredentials, emailOptions);

/**
 * @typedef             EmailMandrillCredentials
 * @prop {'Mandrill'}   service         - Service provider name
 * @prop {Object}       auth            - Authentication data provided by the provider
 * @prop {string}       auth.apiKey     - API Key
 */

/** @type {EmailMandrillCredentials} */
var emailCredentials = {
    service: 'Mandrill',
    auth: {
        apiKey: 'YOUR_API_KEY'
    }
};

/**
 * @typedef             EmailOptions
 * @prop {string}       from            - Sender's email
 * @prop {string}       to              - Recipient email
 * @prop {string}       subject         - Mail subject
 * @prop {string}       [text]          - Email content (use when the message is plain text only)
 * @prop {string}       [html]          - Email content (use when message contains HTML)
 */

/** @type {EmailOptions} */
var emailOptions = {
    from: 'SENDER_EMAIL',
    to: 'RECEIVER_EMAIL',
    subject: 'EMAIL_SUBJECT_TEXT',
    text: 'EMAIL_CONTENT_TEXT'
};

// Send mail
email(emailCredentials, emailOptions);

/**
 * @typedef             EmailMailchimpCredentials
 * @prop {'Mailchimp'}  service         - Service provider name
 * @prop {Object}       auth            - Authentication data provided by the provider
 * @prop {string}       auth.apiKey     - API Key
 */

/** @type {EmailMailchimpCredentials} */
var emailCredentials = {
    service: 'Mailchimp',
    auth: {
        apiKey: 'YOUR_API_KEY'
    }
};

/**
 * @typedef             EmailOptions
 * @prop {string}       from            - Sender's email
 * @prop {string}       to              - Recipient email
 * @prop {string}       subject         - Mail subject
 * @prop {string}       [text]          - Email content (use when the message is plain text only)
 * @prop {string}       [html]          - Email content (use when message contains HTML)
 */

/** @type {EmailOptions} */
var emailOptions = {
    from: 'SENDER_EMAIL',
    to: 'RECEIVER_EMAIL',
    subject: 'EMAIL_SUBJECT_TEXT',
    text: 'EMAIL_CONTENT_TEXT'
};

// Send mail
email(emailCredentials, emailOptions);

/**
 * @typedef             EmailSesCredentials
 * @prop {'SES'}        service                 - Service provider name
 * @prop {Object}       auth                    - Authentication data provided by the provider
 * @prop {string}       auth.accessKeyId        - Access Key ID
 * @prop {string}       auth.secretAccessKey    - Secret Access Key 
 * @prop {string}       auth.region             - Region (For more info: https://www.aws-services.info/ses.html)
 */

/** @type {EmailSesCredentials} */
var emailCredentials = {
    service: 'SES',
    auth: {
        accessKeyId: 'YOUR_ACCESS_KEY_ID',
        secretAccessKey: 'YOUR_SECRET_ACCESS_KEY',
        region: 'us-west-2'
    }
};

/**
 * @typedef             EmailOptions
 * @prop {string}       from                    - Sender's email
 * @prop {string}       to                      - Recipient email
 * @prop {string}       subject                 - Mail subject
 * @prop {string}       [text]                  - Email content (use when the message is plain text only)
 * @prop {string}       [html]                  - Email content (use when message contains HTML)
 */

/** @type {EmailOptions} */
var emailOptions = {
    from: 'SENDER_EMAIL',
    to: 'RECEIVER_EMAIL',
    subject: 'EMAIL_SUBJECT_TEXT',
    text: 'EMAIL_CONTENT_TEXT'
};

// Send mail
email(emailCredentials, emailOptions);

/**
 * @typedef             EmailGmailCredentials
 * @prop {'Gmail'}      service         - Service provider name
 * @prop {Object}       auth            - Authentication data provided by the provider
 * @prop {string}       auth.user       - API User
 * @prop {string}       auth.pass       - API Pass
 */

/** @type {EmailGmailCredentials} */
var emailCredentials = {
    service: 'Gmail',
    auth: {
        user: 'YOUR_USER',
        pass: 'YOUR_PASS'
    }
};

/**
 * @typedef             EmailOptions
 * @prop {string}       from            - Sender's email
 * @prop {string}       to              - Recipient email
 * @prop {string}       subject         - Mail subject
 * @prop {string}       [text]          - Email content (use when the message is plain text only)
 * @prop {string}       [html]          - Email content (use when message contains HTML)
 */

/** @type {EmailOptions} */
var emailOptions = {
    from: 'SENDER_EMAIL',
    to: 'RECEIVER_EMAIL',
    subject: 'EMAIL_SUBJECT_TEXT',
    text: 'EMAIL_CONTENT_TEXT'
};

// Send mail
email(emailCredentials, emailOptions);

/**
 * @typedef {'GET'|'POST'|'PUT'|'PATCH'|'DELETE'}   HttpRequestMethods
 * @typedef {{ [headerName: string]: string }}      HttpRequestHeaders
 * 
 * @typedef                                         HttpRequestOptions
 * @prop {string}                                   host
 * @prop {string}                                   path
 * @prop {number}                                   [port=80]
 * @prop {HttpRequestMethods}                       [method='GET']
 * @prop {boolean}                                  [secure=false]
 * @prop {HttpRequestHeaders}                       [headers]
 */

/** @type {HttpRequestOptions} */
var requestOptions = {
    host: 'example.com',
    path: '/test',
    secure: true
};

/** @type {object} */
var requestBody = {};

httpRequest(requestOptions, requestBody, function (error, result) { /* ... */ });

// Create Twilio client
var twilioClient = new Twilio('YOUR_ACCOUNT_SID', 'YOUR_AUTH_TOKEN');

/**
 * @typedef         	TwilioMessageConfig
 * @prop {string}   	to          	- Message recipient number
 * @prop {string}   	from        	- Message sender number (It must be a number purchased from Twilio)
 * @prop {string}   	body        	- SMS message text
 */

/** @type {TwilioMessageConfig} */
var messageConfig = {
    to: 'RECIPIENT_NUMBER',
    from: 'SENDER_NUMBER',
    body: 'MESSAGE_TEXT'
};

// Send an SMS text message
twilioClient.sendMessage(messageConfig, function (error, response) { /* ... */ });

// Create Twilio client
var twilioClient = new Twilio('YOUR_ACCOUNT_SID', 'YOUR_AUTH_TOKEN');

/**
 * @typedef         	TwilioCallConfig
 * @prop {string}   	to         		- Call recipient number
 * @prop {string}   	from        	- Call sender number (It must be a number purchased from Twilio)
 * @prop {string}   	url         	- A URL that produces an XML document (TwiML) which contains instructions for the call
 */

/** @type {TwilioCallConfig} */
var callConfig = {
    to: 'RECIPIENT_NUMBER',
    from: 'SENDER_NUMBER',
    url: 'EXTERNAL_URL'
};

// Place a phone call, and respond with TwiML instructions from the given URL
twilioClient.makeCall(callConfig, function (error, response) { /* ... */ });

/**
 * @typedef         	TelegramBotOptions
 * @prop {number}   	chat_id          - Id of the chat between bot and user
 * @prop {string}   	text        	 - Text to send to the reciever
 * @prop {string}   	[custom_bot]     - Token of your own telegram custom bot
 */

/** @type {TelegramBotOptions} */
var params = {
    chat_id: 123345,
    text: 'You have reached the maximum water cosumption'
}

telegram.sendMessage(params, function (error, result) { /** ... */ });

/**
 * @typedef         TwitterClientConfig
 * @prop {string}   accessToken             - Access Token
 * @prop {string}   accessTokenSecret       - Access Token Secret
 * @prop {string}   consumerKey             - Consumer Key
 * @prop {string}   consumerSecret          - Consumer Secret
 */

/** @type {TwitterClientConfig} */
var twitterClientConfig = {
    accessToken: 'YOUR_ACCESS_TOKEN',
    accessTokenSecret: 'YOUR_ACCESS_TOKEN_SECRET',
    consumerKey: 'YOUR_CONSUMER_KEY',
    consumerSecret: 'YOUR_CONSUMER_SECRET'
};

// Create Twitter client
var twitterClient = new Twitter(twitterClientConfig);

// ...

/**
 * @typedef         TwitterPostTweetParameters
 * @prop {string}   status                  - Tweet message
 * 
 * In this example, only the parameters to be used have been added to the TwitterPostTweetParameters type. 
 * To see the complete list of parameters, visit the following link:
 * https://developer.twitter.com/en/docs/twitter-api/v1/tweets/post-and-engage/api-reference/post-statuses-update#parameters
 */

/** @type {TwitterPostTweetParameters} */
var tweetParams = {
    status: 'TWEET_TEXT'
};

// Post Tweet
twitterClient.postTweet(tweetParams, function(error, response) { /* ... */ });

/**
 * ===============================================
 * OPTION 1: Without filters
 * ===============================================
 */

/** @type {string} */
var thingToken = 'YOUR_THING_TOKEN';
/** @type {string} */
var resourceName = 'YOUR_RESOURCE_NAME';

thethingsAPI.thingRead(thingToken, resourceName, function (error, result) { /* ... */  })


/**
 * ===============================================
 * OPTION 2: With filters
 * ===============================================
 */

/** @type {string} */
var thingToken = 'YOUR_THING_TOKEN';
/** @type {string} */
var resourceName = 'YOUR_RESOURCE_NAME';
/** 
 * @typedef         ThingReadFilters 
 * @prop {Date}     [startDate]         - The default date is Jan 1st 1970.
 * @prop {Date}     [endDate]           - The default date is current date.
 * @prop {number}   [limit=1]           - Number of values to return. Available range between 1 and 1000. By default, the value is 1.
 * 
 * @type {ThingReadFilters}
 */
var filters = {
    startDate: new Date(0),
    endDarte: new Date(),
    limit: 1
};

thethingsAPI.thingRead(thingToken, resourceName, filters, function (error, result) { /* ... */  }) 

/**
 * ===============================================
 * OPTION 1: Without params
 * ===============================================
 */

/** @type {string} */
var thingToken = 'YOUR_THING_TOKEN';
/** 
 * @typedef           ThingValue 
 * @prop {string}     key             - Resource name.  
 * @prop {any}       	value           - Resource value.
 * @prop {object}     [geo]           - Thing location. 
 * @prop {number}     geo.lat         - Lattitude value. Available range between -90 and 90.
 * @prop {number}     geo.long        - Longitude value. Available range between -180 and 180.
 * 
 * @type {ThingValue[]}
 */
var values = [{
    key: 'temperature',
    value: 35,
    geo: {
        lat: 10,
        long: 25
    }
}];

thethingsAPI.thingWrite(thingToken, { values: values }, function (error, result) { /* ... */  }) 


/**
 * ===============================================
 * OPTION 2: With params
 * ===============================================
 */

/** @type {string} */
var thingToken = 'YOUR_THING_TOKEN';
/** 
 * @typedef           ThingValue 
 * @prop {string}     key             - Resource name.  
 * @prop {any}    		value           - Resource value.
 * @prop {object}     [geo]           - Thing location. 
 * @prop {number}     geo.lat         - Lattitude value. Available range between -90 and 90.
 * @prop {number}     geo.long        - Longitude value. Available range between -180 and 180.
 * 
 * @type {ThingValue[]}
 */
var values = [{
    key: 'temperature',
    value: 35,
    geo: {
        lat: 10,
        long: 25
    }
}];
/** 
 * @typedef          ManagmentOptions
 * @prop {boolean}   [broadcast=true]       - Define if the value need to be notified to the real-time channels (Like the widgets or in the devices subscribed to our Websockeet service)
 * @prop {boolean}   [store=true]           - Define if the value has to be stored in the database.
 * 
 * @type {ManagmentOptions}
 */
var params = {
    broadcast: true,
    store: true,
};

thethingsAPI.thingWrite(thingToken, values, params, function (error, result) { /* ... */  }) 

/** @type {string} */
var functionName = 'YOUR_CLOUD_CODE_FUNCTION_NAME';

/** @type {{ [key: string]: any }} */
var params = {
    // parameter1: 'hello',
    // parameter2: 2015,
    // parameter3: true,
    // ...
};

thethingsAPI.cloudFunction(functionName, params, function (error, result) { /* ... */  });

/** @type {string} */
var thingtoken = 'YOUR_THING_TOKEN';

thethingsAPI.getGeofences(thingtoken, function (error, result) { /* ... */  });