Merge pull request #14 from myDevicesIoT/feat/datatypes-v2

feat: datatypes v2 retrieval

Author: tdeleanu

lib/Services/cayenne.js

@@ -129,6 +129,10 @@ class Cayenne {
    * Begin Device Attribute Routes
    */
 
+  /*
+   * Begin Device Attribute Routes
+   */
+
   /**
    * Gets all attribute groups and attributes for a device
    * @param {String} deviceId The device id to get attributes for
@@ -142,27 +146,37 @@ class Cayenne {
   }
 
   /**
-   * Create or Update an attribute group. Pass null to group_id to create a new group.
+   * Update an attribute group. Pass null to group_id to create a new group.
    * @param {String} deviceId The id of the parent device
    * @param {String?} groupId Optional: Updates group, if null creates instead
-   * @param {Object} payload The group to create or update
+   * @param {Object} payload The group to update
    * @param {UUID?} payload.id Optional: The group id, will be overriden by group_id parameter
    * @param {String} payload.name The name of the group
    * @param {Integer} payload.order The display order of the group
    * @param {String?} payload.device_id Optional: The device id this group is attached to. Overriden by deviceId paramter
    * @param {UUID} payload.user_id The user id of the device owner
    * @param {UUID} payload.client_id The application id of the API call
    */
-  createOrUpdateGroup(deviceId, groupId, payload) {
-    var url = null;
-    if (groupId == null) {
-      url = `${this.url}/things/${deviceId}/groups`;
-    } else {
-      url = `${this.url}/things/${deviceId}/groups/${groupId}`;
-    }
+  updateGroup(deviceId, groupId, payload) {
+    const url = `${this.url}/things/${deviceId}/groups/${groupId}`;
+
     return this.auth.send(this.service, 'PUT', url, { payload });
   }
 
+  /**
+   * Create an attribute group. Pass null to group_id to create a new group.
+   * @param {String} deviceId The id of the parent device
+   * @param {Object} payload The group to create
+   * @param {UUID?} payload.id Optional: The group id, will be overriden by group_id parameter
+   * @param {String} payload.name The name of the group
+   * @param {Integer} payload.order The display order of the group
+   */
+  createGroup(deviceId, payload) {
+    const url = `${this.url}/things/${deviceId}/groups`;
+
+    return this.auth.send(this.service, 'POST', url, { payload });
+  }
+
   /**
    * Delete a group
    * @param {String} deviceId
@@ -177,7 +191,6 @@ class Cayenne {
    * Create or Update an attribute. Pass null to attribute_id to create a new attribute.
    * @param {String} deviceId The id of the parent device
    * @param {String} groupId The id of the parent group
-   * @param {String?} attributeId Optional: Updates attribute, if null creates instead
    * @param {Object} payload The attribute to create or update
    * @param {UUID?} payload.id Optional: The attribute id, will be overriden by attributeId parameter
    * @param {String} payload.name The name of the attribute
@@ -188,15 +201,32 @@ class Cayenne {
    * @param {String} payload.value The value, contents vary based on value_type
    * @param {String} payload.value_type The type of content contained in value string
    */
-  createOrUpdateAttribute(deviceId, groupId, attributeId, payload) {
-    var url = null;
-    if (attributeId == null) {
-      url = `${this.url}/things/${deviceId}/groups/${groupId}/attributes`;
-    } else {
-      url = `${
-        this.url
-      }/things/${deviceId}/groups/${groupId}/attributes/${attributeId}`;
-    }
+  createAttribute(deviceId, groupId, payload) {
+    const url = `${this.url}/things/${deviceId}/groups/${groupId}/attributes`;
+
+    return this.auth.send(this.service, 'POST', url, { payload });
+  }
+
+  /**
+   * Update an attribute. Pass null to attribute_id to create a new attribute.
+   * @param {String} deviceId The id of the parent device
+   * @param {String} groupId The id of the parent group
+   * @param {String?} attributeId Updates attribute
+   * @param {Object} payload The attribute to update
+   * @param {UUID?} payload.id Optional: The attribute id, will be overriden by attributeId parameter
+   * @param {String} payload.name The name of the attribute
+   * @param {Integer} payload.order The display order of the attribute
+   * @param {String?} payload.device_id Optional: The device id this attribute is attached to. Overriden by deviceId paramter
+   * @param {UUID} payload.user_id The user id of the device owner
+   * @param {UUID?} payload.group_id The group id of the parent group
+   * @param {String} payload.value The value, contents vary based on value_type
+   * @param {String} payload.value_type The type of content contained in value string
+   */
+  updateAttribute(deviceId, groupId, attributeId, payload) {
+    const url = `${
+      this.url
+    }/things/${deviceId}/groups/${groupId}/attributes/${attributeId}`;
+
     return this.auth.send(this.service, 'PUT', url, { payload });
   }
 
@@ -213,6 +243,19 @@ class Cayenne {
     return this.auth.send(this.service, 'DELETE', url);
   }
 
+  /**
+   * Get an attribute
+   * @param {String} deviceId
+   * @param {String} groupId
+   * @param {String} attributeId
+   */
+  getAttribute(deviceId, groupId, attributeId) {
+    const url = `${
+      this.url
+    }/things/${deviceId}/groups/${groupId}/attributes/${attributeId}`;
+    return this.auth.send(this.service, 'GET', url);
+  }
+
   /*
    * End Device Attribute Routes
    */
@@ -295,6 +338,44 @@ class Cayenne {
     return this.auth.send(this.service, 'GET', url);
   }
 
+  /**
+   * Gets V2 all things data types
+   * @param {Object} query
+   * @param {Number} [query.limit]
+   * @param {Number} [query.page]
+   */
+  getThingDataTypesV2(query) {
+    const url = `${this.url}/v2/things/datatypes`;
+    return this.auth.send(this.service, 'GET', url, { query });
+  }
+
+  /**
+   * Get V2 one things data type
+   */
+  getThingDataTypeV2(id) {
+    const url = `${this.url}/v2/things/datatypes/${id}`;
+    return this.auth.send(this.service, 'GET', url);
+  }
+
+  /**
+   * Get V2 one things data type properties
+   * @param {Object} query
+   * @param {Number} [query.limit]
+   * @param {Number} [query.page]
+   */
+  getThingDataTypePropertiesV2(id, query) {
+    const url = `${this.url}/v2/things/datatypes/${id}/properties`;
+    return this.auth.send(this.service, 'GET', url, { query });
+  }
+
+  /**
+   * Get V2 one things data type property by it's id
+   */
+  getThingDataTypePropertyV2(id, pid) {
+    const url = `${this.url}/v2/things/datatypes/${id}/properties/${pid}`;
+    return this.auth.send(this.service, 'GET', url);
+  }
+
   /**
    * Gets thing types by query
    * @param {Object} query