particle-api-js 10.5.0 → 10.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "particle-api-js",
-  "version": "10.5.0",
+  "version": "10.6.0",
   "description": "Particle API Client",
   "main": "src/Particle.js",
   "scripts": {

package/src/Agent.js

@@ -255,8 +255,10 @@ class Agent {
         }
         if (query) {
             const queryParams = qs.stringify(query);
-            const hasParams = actualUri.includes('?');
-            actualUri = `${actualUri}${hasParams ? '&' : '?'}${queryParams}`;
+            if (queryParams) {
+                const hasParams = actualUri.includes('?');
+                actualUri = `${actualUri}${hasParams ? '&' : '?'}${queryParams}`;
+            }
         }
 
         const userAgentHeader = { 'User-Agent': `${packageJson.name}/${packageJson.version} (${packageJson.repository.url})` };

package/src/Particle.js

@@ -2631,6 +2631,60 @@ class Particle {
         });
     }
 
+    /**
+     * List Device OS versions
+     *
+     * @param {Object} options                    Options for this API call
+     * @param {Number} [options.platformId]       Platform ID to filter Device OS versions
+     * @param {Number} [options.internalVersion]  Internal version number to filter Device OS versions
+     * @param {Number} [options.page]             Page number for pagination
+     * @param {Number} [options.perPage]          Number of items per page
+     * @param {Auth}   [options.auth]             The access token or basic auth object. Can be ignored if provided in constructor
+     * @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<RequestResponse>}        A promise that resolves to the list of Device OS versions.
+     */
+    listDeviceOsVersions({ platformId, internalVersion, page, perPage, auth, headers, context }) {
+        const query = {
+            platform_id: platformId,
+            internal_version: internalVersion,
+            page,
+            per_page: perPage
+        };
+
+        return this.get({
+            uri: '/v1/device-os/versions',
+            query,
+            auth,
+            headers,
+            context
+        });
+    }
+
+    /**
+     * Get a specific Device OS version
+     *
+     * @param {Object} options               Options for this API call
+     * @param {String} options.version       Version of the Device OS
+     * @param {Number} [options.platformId]  Optional platform ID to filter Device OS version
+     * @param {Auth}   [options.auth]        The access token or basic auth object. Can be ignored if provided in constructor
+     * @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<RequestResponse>}        A promise that resolves to the specified Device OS version data.
+     */
+    getDeviceOsVersion({ version, platformId, auth, headers, context }) {
+        const query = platformId ? { platform_id: platformId } : {};
+        return this.get({
+            uri: `/v1/device-os/versions/${version}`,
+            query,
+            auth,
+            headers,
+            context
+        });
+    }
+
     /**
      * Set default auth token that will be used in each method if `auth` is not provided
      * @param {Auth} auth The access token or basic auth object

package/test/Particle.spec.js

@@ -2889,6 +2889,77 @@ describe('ParticleAPI', () => {
             });
         });
 
+        describe('.listDeviceOsVersions', () => {
+            it('generates request without optional parameters', () => {
+                return api.listDeviceOsVersions({ auth: props.auth }).then((results) => {
+                    results.should.match({
+                        method: 'get',
+                        uri: '/v1/device-os/versions',
+                        auth: props.auth,
+                        query: {}
+                    });
+                });
+            });
+
+            it('generates request with all optional parameters', () => {
+                const options = {
+                    auth: props.auth,
+                    platformId: 6,
+                    internalVersion: '1.2.3',
+                    page: 2,
+                    perPage: 25
+                };
+                return api.listDeviceOsVersions(options).then((results) => {
+                    results.should.match({
+                        method: 'get',
+                        uri: '/v1/device-os/versions',
+                        auth: props.auth,
+                        query: {
+                            platform_id: 6,
+                            internal_version: '1.2.3',
+                            page: 2,
+                            per_page: 25
+                        }
+                    });
+                });
+            });
+        });
+
+        describe('.getDeviceOsVersion', () => {
+            it('generates request without optional parameters', () => {
+                const options = {
+                    auth: props.auth,
+                    version: '1.2.3'
+                };
+                return api.getDeviceOsVersion(options).then((results) => {
+                    results.should.match({
+                        method: 'get',
+                        uri: '/v1/device-os/versions/1.2.3',
+                        auth: props.auth,
+                        query: {}
+                    });
+                });
+            });
+
+            it('generates request with platformId parameter', () => {
+                const options = {
+                    auth: props.auth,
+                    version: '1.2.3',
+                    platformId: 6
+                };
+                return api.getDeviceOsVersion(options).then((results) => {
+                    results.should.match({
+                        method: 'get',
+                        uri: '/v1/device-os/versions/1.2.3',
+                        auth: props.auth,
+                        query: {
+                            platform_id: 6
+                        }
+                    });
+                });
+            });
+        });
+
         describe('.unprotectDevice', () => {
             it('generates request', () => {
                 return api.unprotectDevice(Object.assign({}, propsWithProduct, {