add location service endpoint

Author: busticated

src/Particle.js

@@ -1963,6 +1963,71 @@ class Particle {
 		});
 	}
 
+	/**
+	 * Query location for devices within a product
+	 * @param  {Object} options            Options for this API call
+	 * @param  {String} options.product    Locations for this product ID or slug
+	 * @param  {String} options.auth       Access Token
+	 * @param  {String} options.dateRange  Start and end date in ISO8601 format, separated by comma, to query
+	 * @param  {String} options.rectBl     Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
+	 * @param  {String} options.rectTr     Top right of the rectangular bounding box to query. Latitude and longitude separated by comma
+	 * @param  {String} options.deviceId   Device ID prefix to include in the query
+	 * @param  {String} options.deviceName Device name prefix to include in the query
+	 * @param  {String} options.groups     Array of group names to include in the query
+	 * @param  {String} options.page       Page of results to display. Defaults to 1
+	 * @param  {String} options.perPage    Number of results per page. Defaults to 20. Maximum of 100
+	 * @param {Object} [options.headers]   Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+	 * @param {Object} [options.context]   Request context
+	 * @returns {Promise} A promise
+	 */
+	getProductLocations({ auth, product, dateRange, rectBl, rectTr, deviceId, deviceName, groups, page, perPage, headers, context }){
+		return this.get({
+			uri: `/v1/products/${product}/locations`,
+			query: {
+				date_range: dateRange,
+				rect_bl: rectBl,
+				rect_tr: rectTr,
+				device_id: deviceId,
+				device_name: deviceName,
+				groups,
+				page,
+				per_page: perPage
+			},
+			auth,
+			headers,
+			context
+		});
+	}
+
+	/**
+	 * Query location for one device within a product
+	 * @param  {Object} options           Options for this API call
+	 * @param  {String} options.product   Locations for this product ID or slug
+	 * @param  {String} options.auth      Access Token
+	 * @param  {String} options.dateRange Start and end date in ISO8601 format, separated by comma, to query
+	 * @param  {String} options.rectBl    Bottom left of the rectangular bounding box to query. Latitude and longitude separated by comma
+	 * @param  {String} options.rectTr    Top right of the rectangular bounding box to query. Latitude and longitude separated by comma
+	 * @param  {String} options.deviceId  Device ID to query
+	 * @param {Object} [options.headers]  Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+	 * @param {Object} [options.context]  Request context
+	 * @param {Object} [options.headers]  Key/Value pairs like `{ 'X-FOO': 'foo', X-BAR: 'bar' }` to send as headers.
+	 * @param {Object} [options.context]  Request context
+	 * @returns {Promise} A promise
+	 */
+	getProductDeviceLocations({ auth, product, dateRange, rectBl, rectTr, deviceId, headers, context }){
+		return this.get({
+			uri: `/v1/products/${product}/locations/${deviceId}`,
+			query: {
+				date_range: dateRange,
+				rect_bl: rectBl,
+				rect_tr: rectTr
+			},
+			auth,
+			headers,
+			context
+		});
+	}
+
 	/**
 	 * API URI to access a device
 	 * @param  {Object} options Options for this API call

test/Particle.spec.js

@@ -92,7 +92,10 @@ const props = {
 	otp: '123456',
 	mfaToken: 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
 	networkId: '65535',
-	groups: ['foo', 'bar']
+	groups: ['foo', 'bar'],
+	dateRange: '2020-05-15T18:29:45.000Z,2020-05-19T18:29:45.000Z',
+	rectBl: '56.185412,-4.049868',
+	rectTr: '56.571537,-5.385920'
 };
 
 const product = 'ze-product-v1';
@@ -2374,6 +2377,45 @@ describe('ParticleAPI', () => {
 			});
 		});
 
+		describe('.getProductLocations', () => {
+			it('generates request', () => {
+				return api.getProductLocations(propsWithProduct).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/products/${product}/locations`,
+						auth: props.auth,
+						query: {
+							date_range: props.dateRange,
+							rect_bl: props.rectBl,
+							rect_tr: props.rectTr,
+							device_id: props.deviceId,
+							device_name: props.deviceName,
+							groups: props.groups,
+							page: props.page,
+							per_page: props.perPage
+						}
+					});
+				});
+			});
+		});
+
+		describe('.getProductDeviceLocations', () => {
+			it('generates request', () => {
+				return api.getProductDeviceLocations(propsWithProduct).then((results) => {
+					results.should.match({
+						method: 'get',
+						uri: `/v1/products/${product}/locations/${props.deviceId}`,
+						auth: props.auth,
+						query: {
+							date_range: props.dateRange,
+							rect_bl: props.rectBl,
+							rect_tr: props.rectTr
+						}
+					});
+				});
+			});
+		});
+
 		describe('.deleteUser', () => {
 			it('sends request to delete the current user', () => {
 				return api.deleteUser(props).then(result => {